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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.273 by root, Thu Aug 6 13:45:04 2009 UTC vs.
Revision 1.317 by root, Wed Mar 24 21:22:57 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
…		…
395	correctly.	402	correctly.
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 });
		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).
400		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	428	callbacks to signals in a generic way, which is a pity, as you cannot
…		…
479		503
480	=head2 IDLE WATCHERS	504	=head2 IDLE WATCHERS
481		505
482	$w = AnyEvent->idle (cb => <callback>);	506	$w = AnyEvent->idle (cb => <callback>);
483		507
484	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
485	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.
486	"nothing better to do" is usually defined to be "no other events need
487	attention by the event loop".
488		510
489	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
490	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
491	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.
492		519
493	Most event loops unfortunately do not really support idle watchers (only	520	Unfortunately, most event loops do not really support idle watchers (only
494	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
495	will simply call the callback "from time to time".	522	will simply call the callback "from time to time".
496		523
497	Example: read lines from STDIN, but only process them when the	524	Example: read lines from STDIN, but only process them when the
498	program is otherwise idle:	525	program is otherwise idle:
…		…
592	after => 1,	619	after => 1,
593	cb => sub { $result_ready->send },	620	cb => sub { $result_ready->send },
594	);	621	);
595		622
596	# this "blocks" (while handling events) till the callback	623	# this "blocks" (while handling events) till the callback
597	# calls -<send	624	# calls ->send
598	$result_ready->recv;	625	$result_ready->recv;
599		626
600	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
601	variables are also callable directly.	628	variables are also callable directly.
602		629
…		…
666	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
667	to use a condition variable for the whole process.	694	to use a condition variable for the whole process.
668		695
669	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
670	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
671	>>, 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
672	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
673	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.
674		702
675	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
676	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
677	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).
678		706
…		…
705	begung can potentially be zero:	733	begung can potentially be zero:
706		734
707	my $cv = AnyEvent->condvar;	735	my $cv = AnyEvent->condvar;
708		736
709	my %result;	737	my %result;
710	$cv->begin (sub { $cv->send (\%result) });	738	$cv->begin (sub { shift->send (\%result) });
711		739
712	for my $host (@list_of_hosts) {	740	for my $host (@list_of_hosts) {
713	$cv->begin;	741	$cv->begin;
714	ping_host_then_call_callback $host, sub {	742	ping_host_then_call_callback $host, sub {
715	$result{$host} = ...;	743	$result{$host} = ...;
…		…
806	=over 4	834	=over 4
807		835
808	=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.
809		837
810	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
811	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
812	that, will fall back to its own pure-perl implementation, which is	840	pure-perl implementation, which is available everywhere as it comes with
813	available everywhere as it comes with AnyEvent itself.	841	AnyEvent itself.
814		842
815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	843	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816	AnyEvent::Impl::Event based on Event, very stable, few glitches.
817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	844	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
818		845
819	=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.
820		847
821	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
822	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
823	them. This means that AnyEvent will automatically pick the right backend	850	them. This means that AnyEvent will automatically pick the right backend
824	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
825	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.
826		853
		854	AnyEvent::Impl::Event based on Event, very stable, few glitches.
827	AnyEvent::Impl::Glib based on Glib, slow but very stable.	855	AnyEvent::Impl::Glib based on Glib, slow but very stable.
828	AnyEvent::Impl::Tk based on Tk, very broken.	856	AnyEvent::Impl::Tk based on Tk, very broken.
829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	857	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830	AnyEvent::Impl::POE based on POE, very slow, some limitations.	858	AnyEvent::Impl::POE based on POE, very slow, some limitations.
831	AnyEvent::Impl::Irssi used when running within irssi.	859	AnyEvent::Impl::Irssi used when running within irssi.
…		…
941	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:
942	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
943	array will be ignored.	971	array will be ignored.
944		972
945	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	973	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946	it,as it takes care of these details.	974	it, as it takes care of these details.
947		975
948	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
949	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
950	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
951	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	}
952		993
953	=back	994	=back
954		995
955	=head1 WHAT TO DO IN A MODULE	996	=head1 WHAT TO DO IN A MODULE
956		997
…		…
1105		1146
1106	package AnyEvent;	1147	package AnyEvent;
1107		1148
1108	# basically a tuned-down version of common::sense	1149	# basically a tuned-down version of common::sense
1109	sub common_sense {	1150	sub common_sense {
1110	# no warnings	1151	# from common:.sense 1.0
1111	${^WARNING_BITS} ^= ${^WARNING_BITS};	1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1112	# use strict vars subs	1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113	$^H \|= 0x00000600;	1154	$^H \|= 0x00000600;
1114	}	1155	}
1115		1156
1116	BEGIN { AnyEvent::common_sense }	1157	BEGIN { AnyEvent::common_sense }
1117		1158
1118	use Carp ();	1159	use Carp ();
1119		1160
1120	our $VERSION = 4.91;	1161	our $VERSION = '5.251';
1121	our $MODEL;	1162	our $MODEL;
1122		1163
1123	our $AUTOLOAD;	1164	our $AUTOLOAD;
1124	our @ISA;	1165	our @ISA;
1125		1166
1126	our @REGISTRY;	1167	our @REGISTRY;
1127		1168
1128	our $WIN32;
1129
1130	our $VERBOSE;	1169	our $VERBOSE;
1131		1170
1132	BEGIN {	1171	BEGIN {
1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1172	require "AnyEvent/constants.pl";
		1173
1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1174	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1135		1175
1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137	if ${^TAINT};	1177	if ${^TAINT};
1138		1178
1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1191	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1152	}	1192	}
1153		1193
1154	my @models = (	1194	my @models = (
1155	[EV:: => AnyEvent::Impl::EV:: , 1],	1195	[EV:: => AnyEvent::Impl::EV:: , 1],
1156	[Event:: => AnyEvent::Impl::Event::, 1],
1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1196	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158	# everything below here will not (normally) be autoprobed	1197	# everything below here will not (normally) be autoprobed
1159	# as the pureperl backend should work everywhere	1198	# as the pureperl backend should work everywhere
1160	# and is usually faster	1199	# and is usually faster
		1200	[Event:: => AnyEvent::Impl::Event::, 1],
1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1201	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1202	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1203	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1204	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1205	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1168	[Prima:: => AnyEvent::Impl::POE::],	1208	[Prima:: => AnyEvent::Impl::POE::],
1169	# 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
1170	# byzantine signal and broken child handling, among others.	1210	# byzantine signal and broken child handling, among others.
1171	# 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
1172	# obvious default class.	1212	# obvious default class.
1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175	# [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
1176	);	1217	);
1177		1218
1178	our %method = map +($_ => 1),	1219	our %method = map +($_ => 1),
1179	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);
1180		1221
1181	our @post_detect;	1222	our @post_detect;
1182		1223
1183	sub post_detect(&) {	1224	sub post_detect(&) {
1184	my ($cb) = @_;	1225	my ($cb) = @_;
1185		1226
1186	if ($MODEL) {
1187	$cb->();
1188
1189	undef
1190	} else {
1191	push @post_detect, $cb;	1227	push @post_detect, $cb;
1192		1228
1193	defined wantarray	1229	defined wantarray
1194	? bless \$cb, "AnyEvent::Util::postdetect"	1230	? bless \$cb, "AnyEvent::Util::postdetect"
1195	: ()	1231	: ()
1196	}
1197	}	1232	}
1198		1233
1199	sub AnyEvent::Util::postdetect::DESTROY {	1234	sub AnyEvent::Util::postdetect::DESTROY {
1200	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1235	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1201	}	1236	}
1202		1237
1203	sub detect() {	1238	sub detect() {
		1239	# free some memory
		1240	*detect = sub () { $MODEL };
		1241
		1242	local $!; # for good measure
		1243	local $SIG{__DIE__};
		1244
		1245	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1246	my $model = "AnyEvent::Impl::$1";
		1247	if (eval "require $model") {
		1248	$MODEL = $model;
		1249	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1250	} else {
		1251	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1252	}
		1253	}
		1254
		1255	# check for already loaded models
1204	unless ($MODEL) {	1256	unless ($MODEL) {
1205	local $SIG{__DIE__};	1257	for (@REGISTRY, @models) {
1206		1258	my ($package, $model) = @$_;
1207	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1259	if (${"$package\::VERSION"} > 0) {
1208	my $model = "AnyEvent::Impl::$1";
1209	if (eval "require $model") {	1260	if (eval "require $model") {
1210	$MODEL = $model;	1261	$MODEL = $model;
1211	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1262	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1212	} else {	1263	last;
1213	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1264	}
1214	}	1265	}
1215	}	1266	}
1216		1267
1217	# check for already loaded models
1218	unless ($MODEL) {	1268	unless ($MODEL) {
		1269	# try to autoload a model
1219	for (@REGISTRY, @models) {	1270	for (@REGISTRY, @models) {
1220	my ($package, $model) = @$_;	1271	my ($package, $model, $autoload) = @$_;
		1272	if (
		1273	$autoload
		1274	and eval "require $package"
1221	if (${"$package\::VERSION"} > 0) {	1275	and ${"$package\::VERSION"} > 0
1222	if (eval "require $model") {	1276	and eval "require $model"
		1277	) {
1223	$MODEL = $model;	1278	$MODEL = $model;
1224	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1279	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1225	last;	1280	last;
1226	}
1227	}	1281	}
1228	}	1282	}
1229		1283
1230	unless ($MODEL) {
1231	# try to autoload a model
1232	for (@REGISTRY, @models) {
1233	my ($package, $model, $autoload) = @$_;
1234	if (
1235	$autoload
1236	and eval "require $package"
1237	and ${"$package\::VERSION"} > 0
1238	and eval "require $model"
1239	) {
1240	$MODEL = $model;
1241	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1242	last;
1243	}
1244	}
1245
1246	$MODEL	1284	$MODEL
1247	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1285	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1248	}
1249	}	1286	}
1250
1251	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1252
1253	unshift @ISA, $MODEL;
1254
1255	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1256
1257	(shift @post_detect)->() while @post_detect;
1258	}	1287	}
		1288
		1289	@models = (); # free probe data
		1290
		1291	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1292	unshift @ISA, $MODEL;
		1293
		1294	# now nuke some methods that are overriden by the backend.
		1295	# SUPER is not allowed.
		1296	for (qw(time signal child idle)) {
		1297	undef &{"AnyEvent::Base::$_"}
		1298	if defined &{"$MODEL\::$_"};
		1299	}
		1300
		1301	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1302
		1303	(shift @post_detect)->() while @post_detect;
		1304
		1305	*post_detect = sub(&) {
		1306	shift->();
		1307
		1308	undef
		1309	};
1259		1310
1260	$MODEL	1311	$MODEL
1261	}	1312	}
1262		1313
1263	sub AUTOLOAD {	1314	sub AUTOLOAD {
1264	(my $func = $AUTOLOAD) =~ s/.*://;	1315	(my $func = $AUTOLOAD) =~ s/.*://;
1265		1316
1266	$method{$func}	1317	$method{$func}
1267	or Carp::croak "$func: not a valid method for AnyEvent objects";	1318	or Carp::croak "$func: not a valid AnyEvent class method";
1268		1319
1269	detect unless $MODEL;	1320	detect;
1270		1321
1271	my $class = shift;	1322	my $class = shift;
1272	$class->$func (@_);	1323	$class->$func (@_);
1273	}	1324	}
1274		1325
…		…
1287	# we assume CLOEXEC is already set by perl in all important cases	1338	# we assume CLOEXEC is already set by perl in all important cases
1288		1339
1289	($fh2, $rw)	1340	($fh2, $rw)
1290	}	1341	}
1291		1342
1292	#############################################################################	1343	=head1 SIMPLIFIED AE API
1293	# "new" API, currently only emulation of it	1344
1294	#############################################################################	1345	Starting with version 5.0, AnyEvent officially supports a second, much
		1346	simpler, API that is designed to reduce the calling, typing and memory
		1347	overhead.
		1348
		1349	See the L<AE> manpage for details.
		1350
		1351	=cut
1295		1352
1296	package AE;	1353	package AE;
		1354
		1355	our $VERSION = $AnyEvent::VERSION;
1297		1356
1298	sub io($$$) {	1357	sub io($$$) {
1299	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1358	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1300	}	1359	}
1301		1360
1302	sub timer($$$) {	1361	sub timer($$$) {
1303	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);	1362	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1304	}	1363	}
1305		1364
1306	sub signal($$) {	1365	sub signal($$) {
1307	AnyEvent->signal (signal => $_[0], cb => $_[1]);	1366	AnyEvent->signal (signal => $_[0], cb => $_[1])
1308	}	1367	}
1309		1368
1310	sub child($$) {	1369	sub child($$) {
1311	AnyEvent->child (pid => $_[0], cb => $_[1]);	1370	AnyEvent->child (pid => $_[0], cb => $_[1])
1312	}	1371	}
1313		1372
1314	sub idle($) {	1373	sub idle($) {
1315	AnyEvent->idle (cb => $_[0]);	1374	AnyEvent->idle (cb => $_[0])
1316	}	1375	}
1317		1376
1318	sub cv(;&) {	1377	sub cv(;&) {
1319	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1378	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1320	}	1379	}
…		…
1333		1392
1334	package AnyEvent::Base;	1393	package AnyEvent::Base;
1335		1394
1336	# default implementations for many methods	1395	# default implementations for many methods
1337		1396
1338	sub _time {	1397	sub time {
		1398	eval q{ # poor man's autoloading {}
1339	# probe for availability of Time::HiRes	1399	# probe for availability of Time::HiRes
1340	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1400	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1341	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1401	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1342	*_time = \&Time::HiRes::time;	1402	*AE::time = \&Time::HiRes::time;
1343	# if (eval "use POSIX (); (POSIX::times())...	1403	# if (eval "use POSIX (); (POSIX::times())...
1344	} else {	1404	} else {
1345	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1405	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1346	*_time = sub { time }; # epic fail	1406	*AE::time = sub (){ time }; # epic fail
		1407	}
		1408
		1409	*time = sub { AE::time }; # different prototypes
1347	}	1410	};
		1411	die if $@;
1348		1412
1349	&_time	1413	&time
1350	}	1414	}
1351		1415
1352	sub time { _time }	1416	*now = \&time;
1353	sub now { _time }	1417
1354	sub now_update { }	1418	sub now_update { }
1355		1419
1356	# default implementation for ->condvar	1420	# default implementation for ->condvar
1357		1421
1358	sub condvar {	1422	sub condvar {
		1423	eval q{ # poor man's autoloading {}
		1424	*condvar = sub {
1359	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1425	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1426	};
		1427
		1428	*AE::cv = sub (;&) {
		1429	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1430	};
		1431	};
		1432	die if $@;
		1433
		1434	&condvar
1360	}	1435	}
1361		1436
1362	# default implementation for ->signal	1437	# default implementation for ->signal
1363		1438
1364	our $HAVE_ASYNC_INTERRUPT;	1439	our $HAVE_ASYNC_INTERRUPT;
1365		1440
1366	sub _have_async_interrupt() {	1441	sub _have_async_interrupt() {
1367	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1442	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1368	&& eval "use Async::Interrupt 1.0 (); 1")	1443	&& eval "use Async::Interrupt 1.02 (); 1")
1369	unless defined $HAVE_ASYNC_INTERRUPT;	1444	unless defined $HAVE_ASYNC_INTERRUPT;
1370		1445
1371	$HAVE_ASYNC_INTERRUPT	1446	$HAVE_ASYNC_INTERRUPT
1372	}	1447	}
1373		1448
1374	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1449	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1375	our (%SIG_ASY, %SIG_ASY_W);	1450	our (%SIG_ASY, %SIG_ASY_W);
1376	our ($SIG_COUNT, $SIG_TW);	1451	our ($SIG_COUNT, $SIG_TW);
1377		1452
1378	sub _signal_exec {
1379	$HAVE_ASYNC_INTERRUPT
1380	? $SIGPIPE_R->drain
1381	: sysread $SIGPIPE_R, my $dummy, 9;
1382
1383	while (%SIG_EV) {
1384	for (keys %SIG_EV) {
1385	delete $SIG_EV{$_};
1386	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1387	}
1388	}
1389	}
1390
1391	# install a dummy wakeup watcher to reduce signal catching latency	1453	# install a dummy wakeup watcher to reduce signal catching latency
		1454	# used by Impls
1392	sub _sig_add() {	1455	sub _sig_add() {
1393	unless ($SIG_COUNT++) {	1456	unless ($SIG_COUNT++) {
1394	# try to align timer on a full-second boundary, if possible	1457	# try to align timer on a full-second boundary, if possible
1395	my $NOW = AE::now;	1458	my $NOW = AE::now;
1396		1459
…		…
1406	undef $SIG_TW	1469	undef $SIG_TW
1407	unless --$SIG_COUNT;	1470	unless --$SIG_COUNT;
1408	}	1471	}
1409		1472
1410	our $_sig_name_init; $_sig_name_init = sub {	1473	our $_sig_name_init; $_sig_name_init = sub {
1411	eval q{ # poor man's autoloading	1474	eval q{ # poor man's autoloading {}
1412	undef $_sig_name_init;	1475	undef $_sig_name_init;
1413		1476
1414	if (_have_async_interrupt) {	1477	if (_have_async_interrupt) {
1415	*sig2num = \&Async::Interrupt::sig2num;	1478	*sig2num = \&Async::Interrupt::sig2num;
1416	*sig2name = \&Async::Interrupt::sig2name;	1479	*sig2name = \&Async::Interrupt::sig2name;
…		…
1448	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1511	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1449		1512
1450	} else {	1513	} else {
1451	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1514	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1452		1515
1453	require Fcntl;
1454
1455	if (AnyEvent::WIN32) {	1516	if (AnyEvent::WIN32) {
1456	require AnyEvent::Util;	1517	require AnyEvent::Util;
1457		1518
1458	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1519	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1459	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1520	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1460	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1521	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1461	} else {	1522	} else {
1462	pipe $SIGPIPE_R, $SIGPIPE_W;	1523	pipe $SIGPIPE_R, $SIGPIPE_W;
1463	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1524	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1464	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1525	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1465		1526
1466	# not strictly required, as $^F is normally 2, but let's make sure...	1527	# not strictly required, as $^F is normally 2, but let's make sure...
1467	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1528	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1468	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1529	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1469	}	1530	}
1470		1531
1471	$SIGPIPE_R	1532	$SIGPIPE_R
1472	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1533	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1473		1534
1474	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1535	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1475	}	1536	}
1476		1537
1477	*signal = sub {	1538	*signal = $HAVE_ASYNC_INTERRUPT
		1539	? sub {
1478	my (undef, %arg) = @_;	1540	my (undef, %arg) = @_;
1479		1541
1480	my $signal = uc $arg{signal}
1481	or Carp::croak "required option 'signal' is missing";
1482
1483	if ($HAVE_ASYNC_INTERRUPT) {
1484	# async::interrupt	1542	# async::interrupt
1485
1486	$signal = sig2num $signal;	1543	my $signal = sig2num $arg{signal};
1487	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1544	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1488		1545
1489	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1546	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1490	cb => sub { undef $SIG_EV{$signal} },	1547	cb => sub { undef $SIG_EV{$signal} },
1491	signal => $signal,	1548	signal => $signal,
1492	pipe => [$SIGPIPE_R->filenos],	1549	pipe => [$SIGPIPE_R->filenos],
1493	pipe_autodrain => 0,	1550	pipe_autodrain => 0,
1494	;	1551	;
1495		1552
1496	} else {	1553	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1554	}
		1555	: sub {
		1556	my (undef, %arg) = @_;
		1557
1497	# pure perl	1558	# pure perl
1498
1499	# AE::Util has been loaded in signal
1500	$signal = sig2name $signal;	1559	my $signal = sig2name $arg{signal};
1501	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1560	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1502		1561
1503	$SIG{$signal} \|\|= sub {	1562	$SIG{$signal} \|\|= sub {
1504	local $!;	1563	local $!;
1505	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1564	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1506	undef $SIG_EV{$signal};	1565	undef $SIG_EV{$signal};
1507	};	1566	};
1508		1567
1509	# can't do signal processing without introducing races in pure perl,	1568	# can't do signal processing without introducing races in pure perl,
1510	# so limit the signal latency.	1569	# so limit the signal latency.
1511	_sig_add;	1570	_sig_add;
1512	}
1513		1571
1514	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1572	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1573	}
1515	};	1574	;
1516		1575
1517	*AnyEvent::Base::signal::DESTROY = sub {	1576	*AnyEvent::Base::signal::DESTROY = sub {
1518	my ($signal, $cb) = @{$_[0]};	1577	my ($signal, $cb) = @{$_[0]};
1519		1578
1520	_sig_del;	1579	_sig_del;
…		…
1527	# print weird messages, or just unconditionally exit	1586	# print weird messages, or just unconditionally exit
1528	# instead of getting the default action.	1587	# instead of getting the default action.
1529	undef $SIG{$signal}	1588	undef $SIG{$signal}
1530	unless keys %{ $SIG_CB{$signal} };	1589	unless keys %{ $SIG_CB{$signal} };
1531	};	1590	};
		1591
		1592	*_signal_exec = sub {
		1593	$HAVE_ASYNC_INTERRUPT
		1594	? $SIGPIPE_R->drain
		1595	: sysread $SIGPIPE_R, (my $dummy), 9;
		1596
		1597	while (%SIG_EV) {
		1598	for (keys %SIG_EV) {
		1599	delete $SIG_EV{$_};
		1600	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1601	}
		1602	}
		1603	};
1532	};	1604	};
1533	die if $@;	1605	die if $@;
		1606
1534	&signal	1607	&signal
1535	}	1608	}
1536		1609
1537	# default implementation for ->child	1610	# default implementation for ->child
1538		1611
1539	our %PID_CB;	1612	our %PID_CB;
1540	our $CHLD_W;	1613	our $CHLD_W;
1541	our $CHLD_DELAY_W;	1614	our $CHLD_DELAY_W;
1542	our $WNOHANG;	1615	our $WNOHANG;
1543		1616
		1617	# used by many Impl's
1544	sub _emit_childstatus($$) {	1618	sub _emit_childstatus($$) {
1545	my (undef, $rpid, $rstatus) = @_;	1619	my (undef, $rpid, $rstatus) = @_;
1546		1620
1547	$_->($rpid, $rstatus)	1621	$_->($rpid, $rstatus)
1548	for values %{ $PID_CB{$rpid} \|\| {} },	1622	for values %{ $PID_CB{$rpid} \|\| {} },
1549	values %{ $PID_CB{0} \|\| {} };	1623	values %{ $PID_CB{0} \|\| {} };
1550	}	1624	}
1551		1625
1552	sub _sigchld {
1553	my $pid;
1554
1555	AnyEvent->_emit_childstatus ($pid, $?)
1556	while ($pid = waitpid -1, $WNOHANG) > 0;
1557	}
1558
1559	sub child {	1626	sub child {
		1627	eval q{ # poor man's autoloading {}
		1628	*_sigchld = sub {
		1629	my $pid;
		1630
		1631	AnyEvent->_emit_childstatus ($pid, $?)
		1632	while ($pid = waitpid -1, $WNOHANG) > 0;
		1633	};
		1634
		1635	*child = sub {
1560	my (undef, %arg) = @_;	1636	my (undef, %arg) = @_;
1561		1637
1562	defined (my $pid = $arg{pid} + 0)	1638	defined (my $pid = $arg{pid} + 0)
1563	or Carp::croak "required option 'pid' is missing";	1639	or Carp::croak "required option 'pid' is missing";
1564		1640
1565	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1641	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1566		1642
1567	# WNOHANG is almost cetrainly 1 everywhere	1643	# WNOHANG is almost cetrainly 1 everywhere
1568	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1644	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1569	? 1	1645	? 1
1570	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1646	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1571		1647
1572	unless ($CHLD_W) {	1648	unless ($CHLD_W) {
1573	$CHLD_W = AE::signal CHLD => \&_sigchld;	1649	$CHLD_W = AE::signal CHLD => \&_sigchld;
1574	# child could be a zombie already, so make at least one round	1650	# child could be a zombie already, so make at least one round
1575	&_sigchld;	1651	&_sigchld;
1576	}	1652	}
1577		1653
1578	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1579	}	1655	};
1580		1656
1581	sub AnyEvent::Base::child::DESTROY {	1657	*AnyEvent::Base::child::DESTROY = sub {
1582	my ($pid, $cb) = @{$_[0]};	1658	my ($pid, $cb) = @{$_[0]};
1583		1659
1584	delete $PID_CB{$pid}{$cb};	1660	delete $PID_CB{$pid}{$cb};
1585	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1586		1662
1587	undef $CHLD_W unless keys %PID_CB;	1663	undef $CHLD_W unless keys %PID_CB;
		1664	};
		1665	};
		1666	die if $@;
		1667
		1668	&child
1588	}	1669	}
1589		1670
1590	# idle emulation is done by simply using a timer, regardless	1671	# idle emulation is done by simply using a timer, regardless
1591	# of whether the process is idle or not, and not letting	1672	# of whether the process is idle or not, and not letting
1592	# the callback use more than 50% of the time.	1673	# the callback use more than 50% of the time.
1593	sub idle {	1674	sub idle {
		1675	eval q{ # poor man's autoloading {}
		1676	*idle = sub {
1594	my (undef, %arg) = @_;	1677	my (undef, %arg) = @_;
1595		1678
1596	my ($cb, $w, $rcb) = $arg{cb};	1679	my ($cb, $w, $rcb) = $arg{cb};
1597		1680
1598	$rcb = sub {	1681	$rcb = sub {
1599	if ($cb) {	1682	if ($cb) {
1600	$w = _time;	1683	$w = _time;
1601	&$cb;	1684	&$cb;
1602	$w = _time - $w;	1685	$w = _time - $w;
1603		1686
1604	# never use more then 50% of the time for the idle watcher,	1687	# never use more then 50% of the time for the idle watcher,
1605	# within some limits	1688	# within some limits
1606	$w = 0.0001 if $w < 0.0001;	1689	$w = 0.0001 if $w < 0.0001;
1607	$w = 5 if $w > 5;	1690	$w = 5 if $w > 5;
1608		1691
1609	$w = AE::timer $w, 0, $rcb;	1692	$w = AE::timer $w, 0, $rcb;
1610	} else {	1693	} else {
1611	# clean up...	1694	# clean up...
1612	undef $w;	1695	undef $w;
1613	undef $rcb;	1696	undef $rcb;
		1697	}
		1698	};
		1699
		1700	$w = AE::timer 0.05, 0, $rcb;
		1701
		1702	bless \\$cb, "AnyEvent::Base::idle"
1614	}	1703	};
		1704
		1705	*AnyEvent::Base::idle::DESTROY = sub {
		1706	undef $${$_[0]};
		1707	};
1615	};	1708	};
		1709	die if $@;
1616		1710
1617	$w = AE::timer 0.05, 0, $rcb;	1711	&idle
1618
1619	bless \\$cb, "AnyEvent::Base::idle"
1620	}
1621
1622	sub AnyEvent::Base::idle::DESTROY {
1623	undef $${$_[0]};
1624	}	1712	}
1625		1713
1626	package AnyEvent::CondVar;	1714	package AnyEvent::CondVar;
1627		1715
1628	our @ISA = AnyEvent::CondVar::Base::;	1716	our @ISA = AnyEvent::CondVar::Base::;
…		…
1902	warn "read: $input\n"; # output what has been read	1990	warn "read: $input\n"; # output what has been read
1903	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1991	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1904	},	1992	},
1905	);	1993	);
1906		1994
1907	my $time_watcher; # can only be used once
1908
1909	sub new_timer {
1910	$timer = AnyEvent->timer (after => 1, cb => sub {	1995	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1911	warn "timeout\n"; # print 'timeout' about every second	1996	warn "timeout\n"; # print 'timeout' at most every second
1912	&new_timer; # and restart the time
1913	});	1997	});
1914	}
1915
1916	new_timer; # create first timer
1917		1998
1918	$cv->recv; # wait until user enters /^q/i	1999	$cv->recv; # wait until user enters /^q/i
1919		2000
1920	=head1 REAL-WORLD EXAMPLE	2001	=head1 REAL-WORLD EXAMPLE
1921		2002
…		…
2052	through AnyEvent. The benchmark creates a lot of timers (with a zero	2133	through AnyEvent. The benchmark creates a lot of timers (with a zero
2053	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2134	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2054	which it is), lets them fire exactly once and destroys them again.	2135	which it is), lets them fire exactly once and destroys them again.
2055		2136
2056	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2137	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2057	distribution.	2138	distribution. It uses the L<AE> interface, which makes a real difference
		2139	for the EV and Perl backends only.
2058		2140
2059	=head3 Explanation of the columns	2141	=head3 Explanation of the columns
2060		2142
2061	I<watcher> is the number of event watchers created/destroyed. Since	2143	I<watcher> is the number of event watchers created/destroyed. Since
2062	different event models feature vastly different performances, each event	2144	different event models feature vastly different performances, each event
…		…
2083	watcher.	2165	watcher.
2084		2166
2085	=head3 Results	2167	=head3 Results
2086		2168
2087	name watchers bytes create invoke destroy comment	2169	name watchers bytes create invoke destroy comment
2088	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2170	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2089	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2171	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2090	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2172	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2091	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2173	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2092	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2174	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2093	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2175	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2094	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2176	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2095	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2177	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2096	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2178	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2097	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2179	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2098	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2180	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2099	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2181	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2100		2182
2101	=head3 Discussion	2183	=head3 Discussion
2102		2184
2103	The benchmark does I<not> measure scalability of the event loop very	2185	The benchmark does I<not> measure scalability of the event loop very
2104	well. For example, a select-based event loop (such as the pure perl one)	2186	well. For example, a select-based event loop (such as the pure perl one)
…		…
2116	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2198	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2117	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2199	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2118	cycles with POE.	2200	cycles with POE.
2119		2201
2120	C<EV> is the sole leader regarding speed and memory use, which are both	2202	C<EV> is the sole leader regarding speed and memory use, which are both
2121	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2203	maximal/minimal, respectively. When using the L<AE> API there is zero
		2204	overhead (when going through the AnyEvent API create is about 5-6 times
		2205	slower, with other times being equal, so still uses far less memory than
2122	far less memory than any other event loop and is still faster than Event	2206	any other event loop and is still faster than Event natively).
2123	natively.
2124		2207
2125	The pure perl implementation is hit in a few sweet spots (both the	2208	The pure perl implementation is hit in a few sweet spots (both the
2126	constant timeout and the use of a single fd hit optimisations in the perl	2209	constant timeout and the use of a single fd hit optimisations in the perl
2127	interpreter and the backend itself). Nevertheless this shows that it	2210	interpreter and the backend itself). Nevertheless this shows that it
2128	adds very little overhead in itself. Like any select-based backend its	2211	adds very little overhead in itself. Like any select-based backend its
…		…
2202	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2285	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2203	(1%) are active. This mirrors the activity of large servers with many	2286	(1%) are active. This mirrors the activity of large servers with many
2204	connections, most of which are idle at any one point in time.	2287	connections, most of which are idle at any one point in time.
2205		2288
2206	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2289	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2207	distribution.	2290	distribution. It uses the L<AE> interface, which makes a real difference
		2291	for the EV and Perl backends only.
2208		2292
2209	=head3 Explanation of the columns	2293	=head3 Explanation of the columns
2210		2294
2211	I<sockets> is the number of sockets, and twice the number of "servers" (as	2295	I<sockets> is the number of sockets, and twice the number of "servers" (as
2212	each server has a read and write socket end).	2296	each server has a read and write socket end).
…		…
2220	a new one that moves the timeout into the future.	2304	a new one that moves the timeout into the future.
2221		2305
2222	=head3 Results	2306	=head3 Results
2223		2307
2224	name sockets create request	2308	name sockets create request
2225	EV 20000 69.01 11.16	2309	EV 20000 62.66 7.99
2226	Perl 20000 73.32 35.87	2310	Perl 20000 68.32 32.64
2227	IOAsync 20000 157.00 98.14 epoll	2311	IOAsync 20000 174.06 101.15 epoll
2228	IOAsync 20000 159.31 616.06 poll	2312	IOAsync 20000 174.67 610.84 poll
2229	Event 20000 212.62 257.32	2313	Event 20000 202.69 242.91
2230	Glib 20000 651.16 1896.30	2314	Glib 20000 557.01 1689.52
2231	POE 20000 349.67 12317.24 uses POE::Loop::Event	2315	POE 20000 341.54 12086.32 uses POE::Loop::Event
2232		2316
2233	=head3 Discussion	2317	=head3 Discussion
2234		2318
2235	This benchmark I<does> measure scalability and overall performance of the	2319	This benchmark I<does> measure scalability and overall performance of the
2236	particular event loop.	2320	particular event loop.
…		…
2362	As you can see, the AnyEvent + EV combination even beats the	2446	As you can see, the AnyEvent + EV combination even beats the
2363	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2447	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2364	backend easily beats IO::Lambda and POE.	2448	backend easily beats IO::Lambda and POE.
2365		2449
2366	And even the 100% non-blocking version written using the high-level (and	2450	And even the 100% non-blocking version written using the high-level (and
2367	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2451	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2368	large margin, even though it does all of DNS, tcp-connect and socket I/O	2452	higher level ("unoptimised") abstractions by a large margin, even though
2369	in a non-blocking way.	2453	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2370		2454
2371	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2455	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2372	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2456	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2373	part of the IO::lambda distribution and were used without any changes.	2457	part of the IO::Lambda distribution and were used without any changes.
2374		2458
2375		2459
2376	=head1 SIGNALS	2460	=head1 SIGNALS
2377		2461
2378	AnyEvent currently installs handlers for these signals:	2462	AnyEvent currently installs handlers for these signals:
…		…
2420	it's built-in modules) are required to use it.	2504	it's built-in modules) are required to use it.
2421		2505
2422	That does not mean that AnyEvent won't take advantage of some additional	2506	That does not mean that AnyEvent won't take advantage of some additional
2423	modules if they are installed.	2507	modules if they are installed.
2424		2508
2425	This section epxlains which additional modules will be used, and how they	2509	This section explains which additional modules will be used, and how they
2426	affect AnyEvent's operetion.	2510	affect AnyEvent's operation.
2427		2511
2428	=over 4	2512	=over 4
2429		2513
2430	=item L<Async::Interrupt>	2514	=item L<Async::Interrupt>
2431		2515
…		…
2436	catch the signals) with some delay (default is 10 seconds, look for	2520	catch the signals) with some delay (default is 10 seconds, look for
2437	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2521	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2438		2522
2439	If this module is available, then it will be used to implement signal	2523	If this module is available, then it will be used to implement signal
2440	catching, which means that signals will not be delayed, and the event loop	2524	catching, which means that signals will not be delayed, and the event loop
2441	will not be interrupted regularly, which is more efficient (And good for	2525	will not be interrupted regularly, which is more efficient (and good for
2442	battery life on laptops).	2526	battery life on laptops).
2443		2527
2444	This affects not just the pure-perl event loop, but also other event loops	2528	This affects not just the pure-perl event loop, but also other event loops
2445	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2529	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2446		2530
…		…
2458	automatic timer adjustments even when no monotonic clock is available,	2542	automatic timer adjustments even when no monotonic clock is available,
2459	can take avdantage of advanced kernel interfaces such as C<epoll> and	2543	can take avdantage of advanced kernel interfaces such as C<epoll> and
2460	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2544	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2461	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2545	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2462		2546
		2547	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2548	then this module will do nothing for you.
		2549
2463	=item L<Guard>	2550	=item L<Guard>
2464		2551
2465	The guard module, when used, will be used to implement	2552	The guard module, when used, will be used to implement
2466	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2553	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2467	lot less memory), but otherwise doesn't affect guard operation much. It is	2554	lot less memory), but otherwise doesn't affect guard operation much. It is
2468	purely used for performance.	2555	purely used for performance.
2469		2556
2470	=item L<JSON> and L<JSON::XS>	2557	=item L<JSON> and L<JSON::XS>
2471		2558
2472	This module is required when you want to read or write JSON data via	2559	One of these modules is required when you want to read or write JSON data
2473	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2560	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2474	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2561	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2475
2476	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2477	installed.
2478		2562
2479	=item L<Net::SSLeay>	2563	=item L<Net::SSLeay>
2480		2564
2481	Implementing TLS/SSL in Perl is certainly interesting, but not very	2565	Implementing TLS/SSL in Perl is certainly interesting, but not very
2482	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2566	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2493		2577
2494		2578
2495	=head1 FORK	2579	=head1 FORK
2496		2580
2497	Most event libraries are not fork-safe. The ones who are usually are	2581	Most event libraries are not fork-safe. The ones who are usually are
2498	because they rely on inefficient but fork-safe C<select> or C<poll>	2582	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2499	calls. Only L<EV> is fully fork-aware.	2583	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2584	are usually badly thought-out hacks that are incompatible with fork in
		2585	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2586	continue event-processing in both parent and child (or both, if you know
		2587	what you are doing).
		2588
		2589	This means that, in general, you cannot fork and do event processing in
		2590	the child if the event library was initialised before the fork (which
		2591	usually happens when the first AnyEvent watcher is created, or the library
		2592	is loaded).
2500		2593
2501	If you have to fork, you must either do so I<before> creating your first	2594	If you have to fork, you must either do so I<before> creating your first
2502	watcher OR you must not use AnyEvent at all in the child OR you must do	2595	watcher OR you must not use AnyEvent at all in the child OR you must do
2503	something completely out of the scope of AnyEvent.	2596	something completely out of the scope of AnyEvent.
		2597
		2598	The problem of doing event processing in the parent I<and> the child
		2599	is much more complicated: even for backends that I<are> fork-aware or
		2600	fork-safe, their behaviour is not usually what you want: fork clones all
		2601	watchers, that means all timers, I/O watchers etc. are active in both
		2602	parent and child, which is almost never what you want. USing C<exec>
		2603	to start worker children from some kind of manage rprocess is usually
		2604	preferred, because it is much easier and cleaner, at the expense of having
		2605	to have another binary.
2504		2606
2505		2607
2506	=head1 SECURITY CONSIDERATIONS	2608	=head1 SECURITY CONSIDERATIONS
2507		2609
2508	AnyEvent can be forced to load any event model via	2610	AnyEvent can be forced to load any event model via

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.273 by root, Thu Aug 6 13:45:04 2009 UTC vs. Revision 1.317 by root, Wed Mar 24 21:22:57 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.273 by root, Thu Aug 6 13:45:04 2009 UTC vs.
Revision 1.317 by root, Wed Mar 24 21:22:57 2010 UTC