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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.275 by root, Sun Aug 9 00:24:35 2009 UTC vs.
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 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.92;	1161	our $VERSION = '5.23';
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
1128	our $WIN32;
1129		1168
1130	our $VERBOSE;	1169	our $VERBOSE;
1131		1170
1132	BEGIN {	1171	BEGIN {
1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1172	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
…		…
1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1190	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1152	}	1191	}
1153		1192
1154	my @models = (	1193	my @models = (
1155	[EV:: => AnyEvent::Impl::EV:: , 1],	1194	[EV:: => AnyEvent::Impl::EV:: , 1],
1156	[Event:: => AnyEvent::Impl::Event::, 1],
1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1195	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158	# everything below here will not (normally) be autoprobed	1196	# everything below here will not (normally) be autoprobed
1159	# as the pureperl backend should work everywhere	1197	# as the pureperl backend should work everywhere
1160	# and is usually faster	1198	# and is usually faster
		1199	[Event:: => AnyEvent::Impl::Event::, 1],
1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1200	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1201	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1202	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1203	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1204	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1168	[Prima:: => AnyEvent::Impl::POE::],	1207	[Prima:: => AnyEvent::Impl::POE::],
1169	# IO::Async is just too broken - we would need workarounds for its	1208	# IO::Async is just too broken - we would need workarounds for its
1170	# byzantine signal and broken child handling, among others.	1209	# byzantine signal and broken child handling, among others.
1171	# IO::Async is rather hard to detect, as it doesn't have any	1210	# IO::Async is rather hard to detect, as it doesn't have any
1172	# obvious default class.	1211	# obvious default class.
1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1212	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1215	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176	);	1216	);
1177		1217
1178	our %method = map +($_ => 1),	1218	our %method = map +($_ => 1),
1179	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1180		1220
…		…
1287	# we assume CLOEXEC is already set by perl in all important cases	1327	# we assume CLOEXEC is already set by perl in all important cases
1288		1328
1289	($fh2, $rw)	1329	($fh2, $rw)
1290	}	1330	}
1291		1331
1292	#############################################################################	1332	=head1 SIMPLIFIED AE API
1293	# "new" API, currently only emulation of it	1333
1294	#############################################################################	1334	Starting with version 5.0, AnyEvent officially supports a second, much
		1335	simpler, API that is designed to reduce the calling, typing and memory
		1336	overhead.
		1337
		1338	See the L<AE> manpage for details.
		1339
		1340	=cut
1295		1341
1296	package AE;	1342	package AE;
1297		1343
1298	our $VERSION = $AnyEvent::VERSION;	1344	our $VERSION = $AnyEvent::VERSION;
1299		1345
1300	sub io($$$) {	1346	sub io($$$) {
1301	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1347	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1302	}	1348	}
1303		1349
1304	sub timer($$$) {	1350	sub timer($$$) {
1305	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);	1351	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1306	}	1352	}
1307		1353
1308	sub signal($$) {	1354	sub signal($$) {
1309	AnyEvent->signal (signal => $_[0], cb => $_[1]);	1355	AnyEvent->signal (signal => $_[0], cb => $_[1])
1310	}	1356	}
1311		1357
1312	sub child($$) {	1358	sub child($$) {
1313	AnyEvent->child (pid => $_[0], cb => $_[1]);	1359	AnyEvent->child (pid => $_[0], cb => $_[1])
1314	}	1360	}
1315		1361
1316	sub idle($) {	1362	sub idle($) {
1317	AnyEvent->idle (cb => $_[0]);	1363	AnyEvent->idle (cb => $_[0])
1318	}	1364	}
1319		1365
1320	sub cv(;&) {	1366	sub cv(;&) {
1321	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1367	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1322	}	1368	}
…		…
1335		1381
1336	package AnyEvent::Base;	1382	package AnyEvent::Base;
1337		1383
1338	# default implementations for many methods	1384	# default implementations for many methods
1339		1385
1340	sub _time {	1386	sub _time() {
1341	# probe for availability of Time::HiRes	1387	# probe for availability of Time::HiRes
1342	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1388	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1343	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1389	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1344	*_time = \&Time::HiRes::time;	1390	*_time = \&Time::HiRes::time;
1345	# if (eval "use POSIX (); (POSIX::times())...	1391	# if (eval "use POSIX (); (POSIX::times())...
…		…
1365		1411
1366	our $HAVE_ASYNC_INTERRUPT;	1412	our $HAVE_ASYNC_INTERRUPT;
1367		1413
1368	sub _have_async_interrupt() {	1414	sub _have_async_interrupt() {
1369	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1415	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1370	&& eval "use Async::Interrupt 1.0 (); 1")	1416	&& eval "use Async::Interrupt 1.02 (); 1")
1371	unless defined $HAVE_ASYNC_INTERRUPT;	1417	unless defined $HAVE_ASYNC_INTERRUPT;
1372		1418
1373	$HAVE_ASYNC_INTERRUPT	1419	$HAVE_ASYNC_INTERRUPT
1374	}	1420	}
1375		1421
…		…
1378	our ($SIG_COUNT, $SIG_TW);	1424	our ($SIG_COUNT, $SIG_TW);
1379		1425
1380	sub _signal_exec {	1426	sub _signal_exec {
1381	$HAVE_ASYNC_INTERRUPT	1427	$HAVE_ASYNC_INTERRUPT
1382	? $SIGPIPE_R->drain	1428	? $SIGPIPE_R->drain
1383	: sysread $SIGPIPE_R, my $dummy, 9;	1429	: sysread $SIGPIPE_R, (my $dummy), 9;
1384		1430
1385	while (%SIG_EV) {	1431	while (%SIG_EV) {
1386	for (keys %SIG_EV) {	1432	for (keys %SIG_EV) {
1387	delete $SIG_EV{$_};	1433	delete $SIG_EV{$_};
1388	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1434	$_->() for values %{ $SIG_CB{$_} \|\| {} };
…		…
1904	warn "read: $input\n"; # output what has been read	1950	warn "read: $input\n"; # output what has been read
1905	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1951	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1906	},	1952	},
1907	);	1953	);
1908		1954
1909	my $time_watcher; # can only be used once
1910
1911	sub new_timer {
1912	$timer = AnyEvent->timer (after => 1, cb => sub {	1955	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1913	warn "timeout\n"; # print 'timeout' about every second	1956	warn "timeout\n"; # print 'timeout' at most every second
1914	&new_timer; # and restart the time
1915	});	1957	});
1916	}
1917
1918	new_timer; # create first timer
1919		1958
1920	$cv->recv; # wait until user enters /^q/i	1959	$cv->recv; # wait until user enters /^q/i
1921		1960
1922	=head1 REAL-WORLD EXAMPLE	1961	=head1 REAL-WORLD EXAMPLE
1923		1962
…		…
2054	through AnyEvent. The benchmark creates a lot of timers (with a zero	2093	through AnyEvent. The benchmark creates a lot of timers (with a zero
2055	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2094	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2056	which it is), lets them fire exactly once and destroys them again.	2095	which it is), lets them fire exactly once and destroys them again.
2057		2096
2058	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2097	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2059	distribution.	2098	distribution. It uses the L<AE> interface, which makes a real difference
		2099	for the EV and Perl backends only.
2060		2100
2061	=head3 Explanation of the columns	2101	=head3 Explanation of the columns
2062		2102
2063	I<watcher> is the number of event watchers created/destroyed. Since	2103	I<watcher> is the number of event watchers created/destroyed. Since
2064	different event models feature vastly different performances, each event	2104	different event models feature vastly different performances, each event
…		…
2085	watcher.	2125	watcher.
2086		2126
2087	=head3 Results	2127	=head3 Results
2088		2128
2089	name watchers bytes create invoke destroy comment	2129	name watchers bytes create invoke destroy comment
2090	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2130	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2091	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2131	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2092	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2132	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2093	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2133	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2094	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2134	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2095	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2135	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2096	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2136	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2097	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2137	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2098	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2138	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2099	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2139	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2100	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2140	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2101	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2141	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2102		2142
2103	=head3 Discussion	2143	=head3 Discussion
2104		2144
2105	The benchmark does I<not> measure scalability of the event loop very	2145	The benchmark does I<not> measure scalability of the event loop very
2106	well. For example, a select-based event loop (such as the pure perl one)	2146	well. For example, a select-based event loop (such as the pure perl one)
…		…
2118	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2158	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2119	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2159	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2120	cycles with POE.	2160	cycles with POE.
2121		2161
2122	C<EV> is the sole leader regarding speed and memory use, which are both	2162	C<EV> is the sole leader regarding speed and memory use, which are both
2123	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2163	maximal/minimal, respectively. When using the L<AE> API there is zero
		2164	overhead (when going through the AnyEvent API create is about 5-6 times
		2165	slower, with other times being equal, so still uses far less memory than
2124	far less memory than any other event loop and is still faster than Event	2166	any other event loop and is still faster than Event natively).
2125	natively.
2126		2167
2127	The pure perl implementation is hit in a few sweet spots (both the	2168	The pure perl implementation is hit in a few sweet spots (both the
2128	constant timeout and the use of a single fd hit optimisations in the perl	2169	constant timeout and the use of a single fd hit optimisations in the perl
2129	interpreter and the backend itself). Nevertheless this shows that it	2170	interpreter and the backend itself). Nevertheless this shows that it
2130	adds very little overhead in itself. Like any select-based backend its	2171	adds very little overhead in itself. Like any select-based backend its
…		…
2204	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2245	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2205	(1%) are active. This mirrors the activity of large servers with many	2246	(1%) are active. This mirrors the activity of large servers with many
2206	connections, most of which are idle at any one point in time.	2247	connections, most of which are idle at any one point in time.
2207		2248
2208	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2249	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2209	distribution.	2250	distribution. It uses the L<AE> interface, which makes a real difference
		2251	for the EV and Perl backends only.
2210		2252
2211	=head3 Explanation of the columns	2253	=head3 Explanation of the columns
2212		2254
2213	I<sockets> is the number of sockets, and twice the number of "servers" (as	2255	I<sockets> is the number of sockets, and twice the number of "servers" (as
2214	each server has a read and write socket end).	2256	each server has a read and write socket end).
…		…
2222	a new one that moves the timeout into the future.	2264	a new one that moves the timeout into the future.
2223		2265
2224	=head3 Results	2266	=head3 Results
2225		2267
2226	name sockets create request	2268	name sockets create request
2227	EV 20000 69.01 11.16	2269	EV 20000 62.66 7.99
2228	Perl 20000 73.32 35.87	2270	Perl 20000 68.32 32.64
2229	IOAsync 20000 157.00 98.14 epoll	2271	IOAsync 20000 174.06 101.15 epoll
2230	IOAsync 20000 159.31 616.06 poll	2272	IOAsync 20000 174.67 610.84 poll
2231	Event 20000 212.62 257.32	2273	Event 20000 202.69 242.91
2232	Glib 20000 651.16 1896.30	2274	Glib 20000 557.01 1689.52
2233	POE 20000 349.67 12317.24 uses POE::Loop::Event	2275	POE 20000 341.54 12086.32 uses POE::Loop::Event
2234		2276
2235	=head3 Discussion	2277	=head3 Discussion
2236		2278
2237	This benchmark I<does> measure scalability and overall performance of the	2279	This benchmark I<does> measure scalability and overall performance of the
2238	particular event loop.	2280	particular event loop.
…		…
2364	As you can see, the AnyEvent + EV combination even beats the	2406	As you can see, the AnyEvent + EV combination even beats the
2365	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2407	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2366	backend easily beats IO::Lambda and POE.	2408	backend easily beats IO::Lambda and POE.
2367		2409
2368	And even the 100% non-blocking version written using the high-level (and	2410	And even the 100% non-blocking version written using the high-level (and
2369	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2411	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2370	large margin, even though it does all of DNS, tcp-connect and socket I/O	2412	higher level ("unoptimised") abstractions by a large margin, even though
2371	in a non-blocking way.	2413	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2372		2414
2373	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2415	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2374	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2416	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2375	part of the IO::lambda distribution and were used without any changes.	2417	part of the IO::Lambda distribution and were used without any changes.
2376		2418
2377		2419
2378	=head1 SIGNALS	2420	=head1 SIGNALS
2379		2421
2380	AnyEvent currently installs handlers for these signals:	2422	AnyEvent currently installs handlers for these signals:
…		…
2422	it's built-in modules) are required to use it.	2464	it's built-in modules) are required to use it.
2423		2465
2424	That does not mean that AnyEvent won't take advantage of some additional	2466	That does not mean that AnyEvent won't take advantage of some additional
2425	modules if they are installed.	2467	modules if they are installed.
2426		2468
2427	This section epxlains which additional modules will be used, and how they	2469	This section explains which additional modules will be used, and how they
2428	affect AnyEvent's operetion.	2470	affect AnyEvent's operation.
2429		2471
2430	=over 4	2472	=over 4
2431		2473
2432	=item L<Async::Interrupt>	2474	=item L<Async::Interrupt>
2433		2475
…		…
2438	catch the signals) with some delay (default is 10 seconds, look for	2480	catch the signals) with some delay (default is 10 seconds, look for
2439	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2481	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2440		2482
2441	If this module is available, then it will be used to implement signal	2483	If this module is available, then it will be used to implement signal
2442	catching, which means that signals will not be delayed, and the event loop	2484	catching, which means that signals will not be delayed, and the event loop
2443	will not be interrupted regularly, which is more efficient (And good for	2485	will not be interrupted regularly, which is more efficient (and good for
2444	battery life on laptops).	2486	battery life on laptops).
2445		2487
2446	This affects not just the pure-perl event loop, but also other event loops	2488	This affects not just the pure-perl event loop, but also other event loops
2447	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2489	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2448		2490
…		…
2469	lot less memory), but otherwise doesn't affect guard operation much. It is	2511	lot less memory), but otherwise doesn't affect guard operation much. It is
2470	purely used for performance.	2512	purely used for performance.
2471		2513
2472	=item L<JSON> and L<JSON::XS>	2514	=item L<JSON> and L<JSON::XS>
2473		2515
2474	This module is required when you want to read or write JSON data via	2516	One of these modules is required when you want to read or write JSON data
2475	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2517	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2476	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2518	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2477		2519
2478	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2520	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2479	installed.	2521	installed.
2480		2522
…		…
2495		2537
2496		2538
2497	=head1 FORK	2539	=head1 FORK
2498		2540
2499	Most event libraries are not fork-safe. The ones who are usually are	2541	Most event libraries are not fork-safe. The ones who are usually are
2500	because they rely on inefficient but fork-safe C<select> or C<poll>	2542	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2501	calls. Only L<EV> is fully fork-aware.	2543	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2544	are usually badly thought-out hacks that are incompatible with fork in
		2545	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2546	continue event-processing in both parent and child (or both, if you know
		2547	what you are doing).
		2548
		2549	This means that, in general, you cannot fork and do event processing in
		2550	the child if the event library was initialised before the fork (which
		2551	usually happens when the first AnyEvent watcher is created, or the library
		2552	is loaded).
2502		2553
2503	If you have to fork, you must either do so I<before> creating your first	2554	If you have to fork, you must either do so I<before> creating your first
2504	watcher OR you must not use AnyEvent at all in the child OR you must do	2555	watcher OR you must not use AnyEvent at all in the child OR you must do
2505	something completely out of the scope of AnyEvent.	2556	something completely out of the scope of AnyEvent.
		2557
		2558	The problem of doing event processing in the parent I<and> the child
		2559	is much more complicated: even for backends that I<are> fork-aware or
		2560	fork-safe, their behaviour is not usually what you want: fork clones all
		2561	watchers, that means all timers, I/O watchers etc. are active in both
		2562	parent and child, which is almost never what you want. USing C<exec>
		2563	to start worker children from some kind of manage rprocess is usually
		2564	preferred, because it is much easier and cleaner, at the expense of having
		2565	to have another binary.
2506		2566
2507		2567
2508	=head1 SECURITY CONSIDERATIONS	2568	=head1 SECURITY CONSIDERATIONS
2509		2569
2510	AnyEvent can be forced to load any event model via	2570	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.275 by root, Sun Aug 9 00:24:35 2009 UTC vs. Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.275 by root, Sun Aug 9 00:24:35 2009 UTC vs.
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC