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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC vs.
Revision 1.279 by root, Sun Aug 9 16:05:11 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	event loops.	6	and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
40	=head1 INTRODUCTION/TUTORIAL	40	=head1 INTRODUCTION/TUTORIAL
41		41
42	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
43	in a tutorial or some gentle introduction, have a look at the	43	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	44	L<AnyEvent::Intro> manpage.
		45
		46	=head1 SUPPORT
		47
		48	There is a mailinglist for discussing all things AnyEvent, and an IRC
		49	channel, too.
		50
		51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
45		53
46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47		55
48	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
173	my variables are only visible after the statement in which they are	181	my variables are only visible after the statement in which they are
174	declared.	182	declared.
175		183
176	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
177		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	192	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
180		194
181	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	195	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182	for events (AnyEvent might or might not keep a reference to this file	196	for events (AnyEvent might or might not keep a reference to this file
…		…
211	undef $w;	225	undef $w;
212	});	226	});
213		227
214	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
215		229
		230	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		231
		232	$w = AnyEvent->timer (
		233	after => <fractional_seconds>,
		234	interval => <fractional_seconds>,
		235	cb => <callback>,
		236	);
		237
216	You can create a time watcher by calling the C<< AnyEvent->timer >>	238	You can create a time watcher by calling the C<< AnyEvent->timer >>
217	method with the following mandatory arguments:	239	method with the following mandatory arguments:
218		240
219	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
220	supported) the callback should be invoked. C<cb> is the callback to invoke	242	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
347		369
348	=back	370	=back
349		371
350	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
351		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		375
352	You can watch for signals using a signal watcher, C<signal> is the signal	376	You can watch for signals using a signal watcher, C<signal> is the signal
353	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	377	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
355		379
356	Although the callback might get passed parameters, their value and	380	Although the callback might get passed parameters, their value and
…		…
368		392
369	This watcher might use C<%SIG> (depending on the event loop used),	393	This watcher might use C<%SIG> (depending on the event loop used),
370	so programs overwriting those signals directly will likely not work	394	so programs overwriting those signals directly will likely not work
371	correctly.	395	correctly.
372		396
		397	Example: exit on SIGINT
		398
		399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		400
		401	=head3 Signal Races, Delays and Workarounds
		402
373	Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not	403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
374	support attaching callbacks to signals, which is a pity, as you cannot do	404	callbacks to signals in a generic way, which is a pity, as you cannot
375	race-free signal handling in perl. AnyEvent will try to do it's best, but	405	do race-free signal handling in perl, requiring C libraries for
		406	this. AnyEvent will try to do it's best, which means in some cases,
376	in some cases, signals will be delayed. The maximum time a signal might	407	signals will be delayed. The maximum time a signal might be delayed is
377	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
378	seconds). This variable can be changed only before the first signal	409	variable can be changed only before the first signal watcher is created,
379	watcher is created, and should be left alone otherwise. Higher values	410	and should be left alone otherwise. This variable determines how often
		411	AnyEvent polls for signals (in case a wake-up was missed). Higher values
380	will cause fewer spurious wake-ups, which is better for power and CPU	412	will cause fewer spurious wake-ups, which is better for power and CPU
		413	saving.
		414
381	saving. All these problems can be avoided by installing the optional	415	All these problems can be avoided by installing the optional
382	L<Async::Interrupt> module.	416	L<Async::Interrupt> module, which works with most event loops. It will not
383		417	work with inherently broken event loops such as L<Event> or L<Event::Lib>
384	Example: exit on SIGINT	418	(and not with L<POE> currently, as POE does it's own workaround with
385		419	one-second latency). For those, you just have to suffer the delays.
386	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387		420
388	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
389		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
390	You can also watch on a child process exit and catch its exit status.	425	You can also watch on a child process exit and catch its exit status.
391		426
392	The child process is specified by the C<pid> argument (if set to C<0>, it	427	The child process is specified by the C<pid> argument (one some backends,
393	watches for any child process exit). The watcher will triggered only when	428	using C<0> watches for any child process exit, on others this will
394	the child process has finished and an exit status is available, not on	429	croak). The watcher will be triggered only when the child process has
395	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
396		432
397	The callback will be called with the pid and exit status (as returned by	433	The callback will be called with the pid and exit status (as returned by
398	waitpid), so unlike other watcher types, you I<can> rely on child watcher	434	waitpid), so unlike other watcher types, you I<can> rely on child watcher
399	callback arguments.	435	callback arguments.
400		436
…		…
441	# do something else, then wait for process exit	477	# do something else, then wait for process exit
442	$done->recv;	478	$done->recv;
443		479
444	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
445		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
446	Sometimes there is a need to do something, but it is not so important	484	Sometimes there is a need to do something, but it is not so important
447	to do it instantly, but only when there is nothing better to do. This	485	to do it instantly, but only when there is nothing better to do. This
448	"nothing better to do" is usually defined to be "no other events need	486	"nothing better to do" is usually defined to be "no other events need
449	attention by the event loop".	487	attention by the event loop".
450		488
…		…
476	});	514	});
477	});	515	});
478		516
479	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
480		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
481	If you are familiar with some event loops you will know that all of them	524	If you are familiar with some event loops you will know that all of them
482	require you to run some blocking "loop", "run" or similar function that	525	require you to run some blocking "loop", "run" or similar function that
483	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
484		527
485	AnyEvent is slightly different: it expects somebody else to run the event	528	AnyEvent is slightly different: it expects somebody else to run the event
…		…
504	Condition variables are similar to callbacks, except that you can	547	Condition variables are similar to callbacks, except that you can
505	optionally wait for them. They can also be called merge points - points	548	optionally wait for them. They can also be called merge points - points
506	in time where multiple outstanding events have been processed. And yet	549	in time where multiple outstanding events have been processed. And yet
507	another way to call them is transactions - each condition variable can be	550	another way to call them is transactions - each condition variable can be
508	used to represent a transaction, which finishes at some point and delivers	551	used to represent a transaction, which finishes at some point and delivers
509	a result.	552	a result. And yet some people know them as "futures" - a promise to
		553	compute/deliver something that you can wait for.
510		554
511	Condition variables are very useful to signal that something has finished,	555	Condition variables are very useful to signal that something has finished,
512	for example, if you write a module that does asynchronous http requests,	556	for example, if you write a module that does asynchronous http requests,
513	then a condition variable would be the ideal candidate to signal the	557	then a condition variable would be the ideal candidate to signal the
514	availability of results. The user can either act when the callback is	558	availability of results. The user can either act when the callback is
…		…
746	=item $cb = $cv->cb ($cb->($cv))	790	=item $cb = $cv->cb ($cb->($cv))
747		791
748	This is a mutator function that returns the callback set and optionally	792	This is a mutator function that returns the callback set and optionally
749	replaces it before doing so.	793	replaces it before doing so.
750		794
751	The callback will be called when the condition becomes "true", i.e. when	795	The callback will be called when the condition becomes (or already was)
752	C<send> or C<croak> are called, with the only argument being the condition	796	"true", i.e. when C<send> or C<croak> are called (or were called), with
753	variable itself. Calling C<recv> inside the callback or at any later time	797	the only argument being the condition variable itself. Calling C<recv>
754	is guaranteed not to block.	798	inside the callback or at any later time is guaranteed not to block.
755		799
756	=back	800	=back
757		801
758	=head1 SUPPORTED EVENT LOOPS/BACKENDS	802	=head1 SUPPORTED EVENT LOOPS/BACKENDS
759		803
…		…
762	=over 4	806	=over 4
763		807
764	=item Backends that are autoprobed when no other event loop can be found.	808	=item Backends that are autoprobed when no other event loop can be found.
765		809
766	EV is the preferred backend when no other event loop seems to be in	810	EV is the preferred backend when no other event loop seems to be in
767	use. If EV is not installed, then AnyEvent will try Event, and, failing	811	use. If EV is not installed, then AnyEvent will fall back to its own
768	that, will fall back to its own pure-perl implementation, which is	812	pure-perl implementation, which is available everywhere as it comes with
769	available everywhere as it comes with AnyEvent itself.	813	AnyEvent itself.
770		814
771	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
772	AnyEvent::Impl::Event based on Event, very stable, few glitches.
773	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	816	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
774		817
775	=item Backends that are transparently being picked up when they are used.	818	=item Backends that are transparently being picked up when they are used.
776		819
777	These will be used when they are currently loaded when the first watcher	820	These will be used when they are currently loaded when the first watcher
778	is created, in which case it is assumed that the application is using	821	is created, in which case it is assumed that the application is using
779	them. This means that AnyEvent will automatically pick the right backend	822	them. This means that AnyEvent will automatically pick the right backend
780	when the main program loads an event module before anything starts to	823	when the main program loads an event module before anything starts to
781	create watchers. Nothing special needs to be done by the main program.	824	create watchers. Nothing special needs to be done by the main program.
782		825
		826	AnyEvent::Impl::Event based on Event, very stable, few glitches.
783	AnyEvent::Impl::Glib based on Glib, slow but very stable.	827	AnyEvent::Impl::Glib based on Glib, slow but very stable.
784	AnyEvent::Impl::Tk based on Tk, very broken.	828	AnyEvent::Impl::Tk based on Tk, very broken.
785	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786	AnyEvent::Impl::POE based on POE, very slow, some limitations.	830	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		831	AnyEvent::Impl::Irssi used when running within irssi.
787		832
788	=item Backends with special needs.	833	=item Backends with special needs.
789		834
790	Qt requires the Qt::Application to be instantiated first, but will	835	Qt requires the Qt::Application to be instantiated first, but will
791	otherwise be picked up automatically. As long as the main program	836	otherwise be picked up automatically. As long as the main program
…		…
865	event module detection too early, for example, L<AnyEvent::AIO> creates	910	event module detection too early, for example, L<AnyEvent::AIO> creates
866	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	911	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867	avoid autodetecting the event module at load time.	912	avoid autodetecting the event module at load time.
868		913
869	If called in scalar or list context, then it creates and returns an object	914	If called in scalar or list context, then it creates and returns an object
870	that automatically removes the callback again when it is destroyed. See	915	that automatically removes the callback again when it is destroyed (or
		916	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871	L<Coro::BDB> for a case where this is useful.	917	a case where this is useful.
		918
		919	Example: Create a watcher for the IO::AIO module and store it in
		920	C<$WATCHER>. Only do so after the event loop is initialised, though.
		921
		922	our WATCHER;
		923
		924	my $guard = AnyEvent::post_detect {
		925	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		926	};
		927
		928	# the \|\|= is important in case post_detect immediately runs the block,
		929	# as to not clobber the newly-created watcher. assigning both watcher and
		930	# post_detect guard to the same variable has the advantage of users being
		931	# able to just C<undef $WATCHER> if the watcher causes them grief.
		932
		933	$WATCHER \|\|= $guard;
872		934
873	=item @AnyEvent::post_detect	935	=item @AnyEvent::post_detect
874		936
875	If there are any code references in this array (you can C<push> to it	937	If there are any code references in this array (you can C<push> to it
876	before or after loading AnyEvent), then they will called directly after	938	before or after loading AnyEvent), then they will called directly after
…		…
1041		1103
1042	=cut	1104	=cut
1043		1105
1044	package AnyEvent;	1106	package AnyEvent;
1045		1107
		1108	# basically a tuned-down version of common::sense
		1109	sub common_sense {
1046	no warnings;	1110	# no warnings
		1111	${^WARNING_BITS} ^= ${^WARNING_BITS};
1047	use strict qw(vars subs);	1112	# use strict vars subs
		1113	$^H \|= 0x00000600;
		1114	}
		1115
		1116	BEGIN { AnyEvent::common_sense }
1048		1117
1049	use Carp ();	1118	use Carp ();
1050		1119
1051	our $VERSION = 4.83;	1120	our $VERSION = '5.0';
1052	our $MODEL;	1121	our $MODEL;
1053		1122
1054	our $AUTOLOAD;	1123	our $AUTOLOAD;
1055	our @ISA;	1124	our @ISA;
1056		1125
…		…
1081	for reverse split /\s,\s/,	1150	for reverse split /\s,\s/,
1082	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1083	}	1152	}
1084		1153
1085	my @models = (	1154	my @models = (
1086	[EV:: => AnyEvent::Impl::EV::],	1155	[EV:: => AnyEvent::Impl::EV:: , 1],
1087	[Event:: => AnyEvent::Impl::Event::],
1088	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1156	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1089	# everything below here will not be autoprobed	1157	# everything below here will not (normally) be autoprobed
1090	# as the pureperl backend should work everywhere	1158	# as the pureperl backend should work everywhere
1091	# and is usually faster	1159	# and is usually faster
		1160	[Event:: => AnyEvent::Impl::Event::, 1],
1092	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1093	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1094	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1095	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1096	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1097	[Wx:: => AnyEvent::Impl::POE::],	1167	[Wx:: => AnyEvent::Impl::POE::],
1098	[Prima:: => AnyEvent::Impl::POE::],	1168	[Prima:: => AnyEvent::Impl::POE::],
1099	# IO::Async is just too broken - we would need workarounds for its	1169	# IO::Async is just too broken - we would need workarounds for its
1100	# byzantine signal and broken child handling, among others.	1170	# byzantine signal and broken child handling, among others.
1101	# IO::Async is rather hard to detect, as it doesn't have any	1171	# IO::Async is rather hard to detect, as it doesn't have any
1102	# obvious default class.	1172	# obvious default class.
1103	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1173	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1104	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1105	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1176	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1106	);	1177	);
1107		1178
1108	our %method = map +($_ => 1),	1179	our %method = map +($_ => 1),
1109	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1180	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1110		1181
…		…
1114	my ($cb) = @_;	1185	my ($cb) = @_;
1115		1186
1116	if ($MODEL) {	1187	if ($MODEL) {
1117	$cb->();	1188	$cb->();
1118		1189
1119	1	1190	undef
1120	} else {	1191	} else {
1121	push @post_detect, $cb;	1192	push @post_detect, $cb;
1122		1193
1123	defined wantarray	1194	defined wantarray
1124	? bless \$cb, "AnyEvent::Util::postdetect"	1195	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1130	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1201	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1131	}	1202	}
1132		1203
1133	sub detect() {	1204	sub detect() {
1134	unless ($MODEL) {	1205	unless ($MODEL) {
1135	no strict 'refs';
1136	local $SIG{__DIE__};	1206	local $SIG{__DIE__};
1137		1207
1138	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1208	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1139	my $model = "AnyEvent::Impl::$1";	1209	my $model = "AnyEvent::Impl::$1";
1140	if (eval "require $model") {	1210	if (eval "require $model") {
…		…
1157	}	1227	}
1158	}	1228	}
1159	}	1229	}
1160		1230
1161	unless ($MODEL) {	1231	unless ($MODEL) {
1162	# try to load a model	1232	# try to autoload a model
1163
1164	for (@REGISTRY, @models) {	1233	for (@REGISTRY, @models) {
1165	my ($package, $model) = @$_;	1234	my ($package, $model, $autoload) = @$_;
		1235	if (
		1236	$autoload
1166	if (eval "require $package"	1237	and eval "require $package"
1167	and ${"$package\::VERSION"} > 0	1238	and ${"$package\::VERSION"} > 0
1168	and eval "require $model") {	1239	and eval "require $model"
		1240	) {
1169	$MODEL = $model;	1241	$MODEL = $model;
1170	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1242	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1171	last;	1243	last;
1172	}	1244	}
1173	}	1245	}
1174		1246
1175	$MODEL	1247	$MODEL
…		…
1214	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";	1286	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1215		1287
1216	# we assume CLOEXEC is already set by perl in all important cases	1288	# we assume CLOEXEC is already set by perl in all important cases
1217		1289
1218	($fh2, $rw)	1290	($fh2, $rw)
		1291	}
		1292
		1293	=head1 SIMPLIFIED AE API
		1294
		1295	Starting with version 5.0, AnyEvent officially supports a second, much
		1296	simpler, API that is designed to reduce the calling, typing and memory
		1297	overhead.
		1298
		1299	See the L<AE> manpage for details.
		1300
		1301	=cut
		1302
		1303	package AE;
		1304
		1305	our $VERSION = $AnyEvent::VERSION;
		1306
		1307	sub io($$$) {
		1308	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1309	}
		1310
		1311	sub timer($$$) {
		1312	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1313	}
		1314
		1315	sub signal($$) {
		1316	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1317	}
		1318
		1319	sub child($$) {
		1320	AnyEvent->child (pid => $_[0], cb => $_[1])
		1321	}
		1322
		1323	sub idle($) {
		1324	AnyEvent->idle (cb => $_[0])
		1325	}
		1326
		1327	sub cv(;&) {
		1328	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1329	}
		1330
		1331	sub now() {
		1332	AnyEvent->now
		1333	}
		1334
		1335	sub now_update() {
		1336	AnyEvent->now_update
		1337	}
		1338
		1339	sub time() {
		1340	AnyEvent->time
1219	}	1341	}
1220		1342
1221	package AnyEvent::Base;	1343	package AnyEvent::Base;
1222		1344
1223	# default implementations for many methods	1345	# default implementations for many methods
…		…
1247	}	1369	}
1248		1370
1249	# default implementation for ->signal	1371	# default implementation for ->signal
1250		1372
1251	our $HAVE_ASYNC_INTERRUPT;	1373	our $HAVE_ASYNC_INTERRUPT;
		1374
		1375	sub _have_async_interrupt() {
		1376	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1377	&& eval "use Async::Interrupt 1.0 (); 1")
		1378	unless defined $HAVE_ASYNC_INTERRUPT;
		1379
		1380	$HAVE_ASYNC_INTERRUPT
		1381	}
		1382
1252	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1383	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1253	our (%SIG_ASY, %SIG_ASY_W);	1384	our (%SIG_ASY, %SIG_ASY_W);
1254	our ($SIG_COUNT, $SIG_TW);	1385	our ($SIG_COUNT, $SIG_TW);
1255		1386
1256	sub _signal_exec {	1387	sub _signal_exec {
…		…
1264	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1395	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1265	}	1396	}
1266	}	1397	}
1267	}	1398	}
1268		1399
		1400	# install a dummy wakeup watcher to reduce signal catching latency
1269	sub _signal {	1401	sub _sig_add() {
1270	my (undef, %arg) = @_;	1402	unless ($SIG_COUNT++) {
		1403	# try to align timer on a full-second boundary, if possible
		1404	my $NOW = AE::now;
1271		1405
1272	my $signal = uc $arg{signal}	1406	$SIG_TW = AE::timer
1273	or Carp::croak "required option 'signal' is missing";	1407	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1274		1408	$MAX_SIGNAL_LATENCY,
1275	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1409	sub { } # just for the PERL_ASYNC_CHECK
1276
1277	if ($HAVE_ASYNC_INTERRUPT) {
1278	# async::interrupt
1279
1280	$SIG_ASY{$signal} \|\|= do {
1281	my $asy = new Async::Interrupt
1282	cb => sub { undef $SIG_EV{$signal} },
1283	signal => $signal,
1284	pipe => [$SIGPIPE_R->filenos],
1285	;
1286	$asy->pipe_autodrain (0);
1287
1288	$asy
1289	};	1410	;
1290
1291	} else {
1292	# pure perl
1293
1294	$SIG{$signal} \|\|= sub {
1295	local $!;
1296	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1297	undef $SIG_EV{$signal};
1298	};
1299
1300	# can't do signal processing without introducing races in pure perl,
1301	# so limit the signal latency.
1302	++$SIG_COUNT;
1303	$SIG_TW \|\|= AnyEvent->timer (
1304	after => $MAX_SIGNAL_LATENCY,
1305	interval => $MAX_SIGNAL_LATENCY,
1306	cb => sub { }, # just for the PERL_ASYNC_CHECK
1307	);
1308	}	1411	}
1309
1310	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1311	}	1412	}
1312		1413
1313	sub signal {	1414	sub _sig_del {
1314	# probe for availability of Async::Interrupt
1315	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1316	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1317
1318	$HAVE_ASYNC_INTERRUPT = 1;
1319	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1320	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1321
1322	} else {
1323	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1324
1325	require Fcntl;
1326
1327	if (AnyEvent::WIN32) {
1328	require AnyEvent::Util;
1329
1330	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1331	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1332	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1333	} else {
1334	pipe $SIGPIPE_R, $SIGPIPE_W;
1335	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1336	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1337
1338	# not strictly required, as $^F is normally 2, but let's make sure...
1339	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1340	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1341	}
1342
1343	$SIGPIPE_R
1344	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1345
1346	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1347	}
1348
1349	*signal = \&_signal;
1350	&signal
1351	}
1352
1353	sub AnyEvent::Base::signal::DESTROY {
1354	my ($signal, $cb) = @{$_[0]};
1355
1356	undef $SIG_TW	1415	undef $SIG_TW
1357	unless --$SIG_COUNT;	1416	unless --$SIG_COUNT;
		1417	}
1358		1418
		1419	our $_sig_name_init; $_sig_name_init = sub {
		1420	eval q{ # poor man's autoloading
		1421	undef $_sig_name_init;
		1422
		1423	if (_have_async_interrupt) {
		1424	*sig2num = \&Async::Interrupt::sig2num;
		1425	*sig2name = \&Async::Interrupt::sig2name;
		1426	} else {
		1427	require Config;
		1428
		1429	my %signame2num;
		1430	@signame2num{ split ' ', $Config::Config{sig_name} }
		1431	= split ' ', $Config::Config{sig_num};
		1432
		1433	my @signum2name;
		1434	@signum2name[values %signame2num] = keys %signame2num;
		1435
		1436	*sig2num = sub($) {
		1437	$_[0] > 0 ? shift : $signame2num{+shift}
		1438	};
		1439	*sig2name = sub ($) {
		1440	$_[0] > 0 ? $signum2name[+shift] : shift
		1441	};
		1442	}
		1443	};
		1444	die if $@;
		1445	};
		1446
		1447	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1448	sub sig2name($) { &$_sig_name_init; &sig2name }
		1449
		1450	sub signal {
		1451	eval q{ # poor man's autoloading {}
		1452	# probe for availability of Async::Interrupt
		1453	if (_have_async_interrupt) {
		1454	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1455
		1456	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1457	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1458
		1459	} else {
		1460	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1461
		1462	require Fcntl;
		1463
		1464	if (AnyEvent::WIN32) {
		1465	require AnyEvent::Util;
		1466
		1467	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1468	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1470	} else {
		1471	pipe $SIGPIPE_R, $SIGPIPE_W;
		1472	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1473	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1474
		1475	# not strictly required, as $^F is normally 2, but let's make sure...
		1476	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1477	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1478	}
		1479
		1480	$SIGPIPE_R
		1481	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1482
		1483	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1484	}
		1485
		1486	*signal = sub {
		1487	my (undef, %arg) = @_;
		1488
		1489	my $signal = uc $arg{signal}
		1490	or Carp::croak "required option 'signal' is missing";
		1491
		1492	if ($HAVE_ASYNC_INTERRUPT) {
		1493	# async::interrupt
		1494
		1495	$signal = sig2num $signal;
		1496	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1497
		1498	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1499	cb => sub { undef $SIG_EV{$signal} },
		1500	signal => $signal,
		1501	pipe => [$SIGPIPE_R->filenos],
		1502	pipe_autodrain => 0,
		1503	;
		1504
		1505	} else {
		1506	# pure perl
		1507
		1508	# AE::Util has been loaded in signal
		1509	$signal = sig2name $signal;
		1510	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1511
		1512	$SIG{$signal} \|\|= sub {
		1513	local $!;
		1514	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1515	undef $SIG_EV{$signal};
		1516	};
		1517
		1518	# can't do signal processing without introducing races in pure perl,
		1519	# so limit the signal latency.
		1520	_sig_add;
		1521	}
		1522
		1523	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1524	};
		1525
		1526	*AnyEvent::Base::signal::DESTROY = sub {
		1527	my ($signal, $cb) = @{$_[0]};
		1528
		1529	_sig_del;
		1530
1359	delete $SIG_CB{$signal}{$cb};	1531	delete $SIG_CB{$signal}{$cb};
1360		1532
		1533	$HAVE_ASYNC_INTERRUPT
		1534	? delete $SIG_ASY{$signal}
1361	# delete doesn't work with older perls - they then	1535	: # delete doesn't work with older perls - they then
1362	# print weird messages, or just unconditionally exit	1536	# print weird messages, or just unconditionally exit
1363	# instead of getting the default action.	1537	# instead of getting the default action.
1364	undef $SIG{$signal}	1538	undef $SIG{$signal}
1365	unless keys %{ $SIG_CB{$signal} };	1539	unless keys %{ $SIG_CB{$signal} };
		1540	};
		1541	};
		1542	die if $@;
		1543	&signal
1366	}	1544	}
1367		1545
1368	# default implementation for ->child	1546	# default implementation for ->child
1369		1547
1370	our %PID_CB;	1548	our %PID_CB;
1371	our $CHLD_W;	1549	our $CHLD_W;
1372	our $CHLD_DELAY_W;	1550	our $CHLD_DELAY_W;
1373	our $WNOHANG;	1551	our $WNOHANG;
1374		1552
		1553	sub _emit_childstatus($$) {
		1554	my (undef, $rpid, $rstatus) = @_;
		1555
		1556	$_->($rpid, $rstatus)
		1557	for values %{ $PID_CB{$rpid} \|\| {} },
		1558	values %{ $PID_CB{0} \|\| {} };
		1559	}
		1560
1375	sub _sigchld {	1561	sub _sigchld {
		1562	my $pid;
		1563
		1564	AnyEvent->_emit_childstatus ($pid, $?)
1376	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1565	while ($pid = waitpid -1, $WNOHANG) > 0;
1377	$_->($pid, $?)
1378	for values %{ $PID_CB{$pid} \|\| {} },
1379	values %{ $PID_CB{0} \|\| {} };
1380	}
1381	}	1566	}
1382		1567
1383	sub child {	1568	sub child {
1384	my (undef, %arg) = @_;	1569	my (undef, %arg) = @_;
1385		1570
1386	defined (my $pid = $arg{pid} + 0)	1571	defined (my $pid = $arg{pid} + 0)
1387	or Carp::croak "required option 'pid' is missing";	1572	or Carp::croak "required option 'pid' is missing";
1388		1573
1389	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1574	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1390		1575
		1576	# WNOHANG is almost cetrainly 1 everywhere
		1577	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1578	? 1
1391	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1579	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1392		1580
1393	unless ($CHLD_W) {	1581	unless ($CHLD_W) {
1394	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1582	$CHLD_W = AE::signal CHLD => \&_sigchld;
1395	# child could be a zombie already, so make at least one round	1583	# child could be a zombie already, so make at least one round
1396	&_sigchld;	1584	&_sigchld;
1397	}	1585	}
1398		1586
1399	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1587	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1425	# never use more then 50% of the time for the idle watcher,	1613	# never use more then 50% of the time for the idle watcher,
1426	# within some limits	1614	# within some limits
1427	$w = 0.0001 if $w < 0.0001;	1615	$w = 0.0001 if $w < 0.0001;
1428	$w = 5 if $w > 5;	1616	$w = 5 if $w > 5;
1429		1617
1430	$w = AnyEvent->timer (after => $w, cb => $rcb);	1618	$w = AE::timer $w, 0, $rcb;
1431	} else {	1619	} else {
1432	# clean up...	1620	# clean up...
1433	undef $w;	1621	undef $w;
1434	undef $rcb;	1622	undef $rcb;
1435	}	1623	}
1436	};	1624	};
1437		1625
1438	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1626	$w = AE::timer 0.05, 0, $rcb;
1439		1627
1440	bless \\$cb, "AnyEvent::Base::idle"	1628	bless \\$cb, "AnyEvent::Base::idle"
1441	}	1629	}
1442		1630
1443	sub AnyEvent::Base::idle::DESTROY {	1631	sub AnyEvent::Base::idle::DESTROY {
…		…
1448		1636
1449	our @ISA = AnyEvent::CondVar::Base::;	1637	our @ISA = AnyEvent::CondVar::Base::;
1450		1638
1451	package AnyEvent::CondVar::Base;	1639	package AnyEvent::CondVar::Base;
1452		1640
1453	use overload	1641	#use overload
1454	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1642	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1455	fallback => 1;	1643	# fallback => 1;
		1644
		1645	# save 300+ kilobytes by dirtily hardcoding overloading
		1646	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1647	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1648	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1649	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1456		1650
1457	our $WAITING;	1651	our $WAITING;
1458		1652
1459	sub _send {	1653	sub _send {
1460	# nop	1654	# nop
…		…
1491	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1685	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1492	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1686	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1493	}	1687	}
1494		1688
1495	sub cb {	1689	sub cb {
1496	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1690	my $cv = shift;
		1691
		1692	@_
		1693	and $cv->{_ae_cb} = shift
		1694	and $cv->{_ae_sent}
		1695	and (delete $cv->{_ae_cb})->($cv);
		1696
1497	$_[0]{_ae_cb}	1697	$cv->{_ae_cb}
1498	}	1698	}
1499		1699
1500	sub begin {	1700	sub begin {
1501	++$_[0]{_ae_counter};	1701	++$_[0]{_ae_counter};
1502	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1702	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1551	C<PERL_ANYEVENT_MODEL>.	1751	C<PERL_ANYEVENT_MODEL>.
1552		1752
1553	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1753	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1554	model it chooses.	1754	model it chooses.
1555		1755
		1756	When set to C<8> or higher, then AnyEvent will report extra information on
		1757	which optional modules it loads and how it implements certain features.
		1758
1556	=item C<PERL_ANYEVENT_STRICT>	1759	=item C<PERL_ANYEVENT_STRICT>
1557		1760
1558	AnyEvent does not do much argument checking by default, as thorough	1761	AnyEvent does not do much argument checking by default, as thorough
1559	argument checking is very costly. Setting this variable to a true value	1762	argument checking is very costly. Setting this variable to a true value
1560	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1763	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1561	check the arguments passed to most method calls. If it finds any problems,	1764	check the arguments passed to most method calls. If it finds any problems,
1562	it will croak.	1765	it will croak.
1563		1766
1564	In other words, enables "strict" mode.	1767	In other words, enables "strict" mode.
1565		1768
1566	Unlike C<use strict>, it is definitely recommended to keep it off in	1769	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1567	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1770	>>, it is definitely recommended to keep it off in production. Keeping
1568	developing programs can be very useful, however.	1771	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1772	can be very useful, however.
1569		1773
1570	=item C<PERL_ANYEVENT_MODEL>	1774	=item C<PERL_ANYEVENT_MODEL>
1571		1775
1572	This can be used to specify the event model to be used by AnyEvent, before	1776	This can be used to specify the event model to be used by AnyEvent, before
1573	auto detection and -probing kicks in. It must be a string consisting	1777	auto detection and -probing kicks in. It must be a string consisting
…		…
1635		1839
1636	When neither C<ca_file> nor C<ca_path> was specified during	1840	When neither C<ca_file> nor C<ca_path> was specified during
1637	L<AnyEvent::TLS> context creation, and either of these environment	1841	L<AnyEvent::TLS> context creation, and either of these environment
1638	variables exist, they will be used to specify CA certificate locations	1842	variables exist, they will be used to specify CA certificate locations
1639	instead of a system-dependent default.	1843	instead of a system-dependent default.
		1844
		1845	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1846
		1847	When these are set to C<1>, then the respective modules are not
		1848	loaded. Mostly good for testing AnyEvent itself.
1640		1849
1641	=back	1850	=back
1642		1851
1643	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1852	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1644		1853
…		…
1852	through AnyEvent. The benchmark creates a lot of timers (with a zero	2061	through AnyEvent. The benchmark creates a lot of timers (with a zero
1853	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2062	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1854	which it is), lets them fire exactly once and destroys them again.	2063	which it is), lets them fire exactly once and destroys them again.
1855		2064
1856	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2065	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1857	distribution.	2066	distribution. It uses the L<AE> interface, which makes a real difference
		2067	for the EV and Perl backends only.
1858		2068
1859	=head3 Explanation of the columns	2069	=head3 Explanation of the columns
1860		2070
1861	I<watcher> is the number of event watchers created/destroyed. Since	2071	I<watcher> is the number of event watchers created/destroyed. Since
1862	different event models feature vastly different performances, each event	2072	different event models feature vastly different performances, each event
…		…
1883	watcher.	2093	watcher.
1884		2094
1885	=head3 Results	2095	=head3 Results
1886		2096
1887	name watchers bytes create invoke destroy comment	2097	name watchers bytes create invoke destroy comment
1888	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2098	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1889	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2099	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1890	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2100	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1891	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2101	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1892	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2102	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1893	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2103	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1894	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2104	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1895	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2105	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1896	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2106	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1897	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2107	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1898	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2108	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1899	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2109	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1900		2110
1901	=head3 Discussion	2111	=head3 Discussion
1902		2112
1903	The benchmark does I<not> measure scalability of the event loop very	2113	The benchmark does I<not> measure scalability of the event loop very
1904	well. For example, a select-based event loop (such as the pure perl one)	2114	well. For example, a select-based event loop (such as the pure perl one)
…		…
1916	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2126	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1917	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2127	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1918	cycles with POE.	2128	cycles with POE.
1919		2129
1920	C<EV> is the sole leader regarding speed and memory use, which are both	2130	C<EV> is the sole leader regarding speed and memory use, which are both
1921	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2131	maximal/minimal, respectively. When using the L<AE> API there is zero
		2132	overhead (when going through the AnyEvent API create is about 5-6 times
		2133	slower, with other times being equal, so still uses far less memory than
1922	far less memory than any other event loop and is still faster than Event	2134	any other event loop and is still faster than Event natively).
1923	natively.
1924		2135
1925	The pure perl implementation is hit in a few sweet spots (both the	2136	The pure perl implementation is hit in a few sweet spots (both the
1926	constant timeout and the use of a single fd hit optimisations in the perl	2137	constant timeout and the use of a single fd hit optimisations in the perl
1927	interpreter and the backend itself). Nevertheless this shows that it	2138	interpreter and the backend itself). Nevertheless this shows that it
1928	adds very little overhead in itself. Like any select-based backend its	2139	adds very little overhead in itself. Like any select-based backend its
…		…
2002	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2213	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2003	(1%) are active. This mirrors the activity of large servers with many	2214	(1%) are active. This mirrors the activity of large servers with many
2004	connections, most of which are idle at any one point in time.	2215	connections, most of which are idle at any one point in time.
2005		2216
2006	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2217	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2007	distribution.	2218	distribution. It uses the L<AE> interface, which makes a real difference
		2219	for the EV and Perl backends only.
2008		2220
2009	=head3 Explanation of the columns	2221	=head3 Explanation of the columns
2010		2222
2011	I<sockets> is the number of sockets, and twice the number of "servers" (as	2223	I<sockets> is the number of sockets, and twice the number of "servers" (as
2012	each server has a read and write socket end).	2224	each server has a read and write socket end).
…		…
2020	a new one that moves the timeout into the future.	2232	a new one that moves the timeout into the future.
2021		2233
2022	=head3 Results	2234	=head3 Results
2023		2235
2024	name sockets create request	2236	name sockets create request
2025	EV 20000 69.01 11.16	2237	EV 20000 62.66 7.99
2026	Perl 20000 73.32 35.87	2238	Perl 20000 68.32 32.64
2027	IOAsync 20000 157.00 98.14 epoll	2239	IOAsync 20000 174.06 101.15 epoll
2028	IOAsync 20000 159.31 616.06 poll	2240	IOAsync 20000 174.67 610.84 poll
2029	Event 20000 212.62 257.32	2241	Event 20000 202.69 242.91
2030	Glib 20000 651.16 1896.30	2242	Glib 20000 557.01 1689.52
2031	POE 20000 349.67 12317.24 uses POE::Loop::Event	2243	POE 20000 341.54 12086.32 uses POE::Loop::Event
2032		2244
2033	=head3 Discussion	2245	=head3 Discussion
2034		2246
2035	This benchmark I<does> measure scalability and overall performance of the	2247	This benchmark I<does> measure scalability and overall performance of the
2036	particular event loop.	2248	particular event loop.
…		…
2231		2443
2232	This slightly arcane module is used to implement fast signal handling: To	2444	This slightly arcane module is used to implement fast signal handling: To
2233	my knowledge, there is no way to do completely race-free and quick	2445	my knowledge, there is no way to do completely race-free and quick
2234	signal handling in pure perl. To ensure that signals still get	2446	signal handling in pure perl. To ensure that signals still get
2235	delivered, AnyEvent will start an interval timer to wake up perl (and	2447	delivered, AnyEvent will start an interval timer to wake up perl (and
2236	catch the signals) with soemd elay (default is 10 seconds, look for	2448	catch the signals) with some delay (default is 10 seconds, look for
2237	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2449	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2238		2450
2239	If this module is available, then it will be used to implement signal	2451	If this module is available, then it will be used to implement signal
2240	catching, which means that signals will not be delayed, and the event loop	2452	catching, which means that signals will not be delayed, and the event loop
2241	will not be interrupted regularly, which is more efficient (And good for	2453	will not be interrupted regularly, which is more efficient (And good for
2242	battery life on laptops).	2454	battery life on laptops).
2243		2455
2244	This affects not just the pure-perl event loop, but also other event loops	2456	This affects not just the pure-perl event loop, but also other event loops
2245	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2457	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2458
		2459	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2460	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2461	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2462	does nothing for those backends.
2246		2463
2247	=item L<EV>	2464	=item L<EV>
2248		2465
2249	This module isn't really "optional", as it is simply one of the backend	2466	This module isn't really "optional", as it is simply one of the backend
2250	event loops that AnyEvent can use. However, it is simply the best event	2467	event loops that AnyEvent can use. However, it is simply the best event
…		…
2264		2481
2265	=item L<JSON> and L<JSON::XS>	2482	=item L<JSON> and L<JSON::XS>
2266		2483
2267	This module is required when you want to read or write JSON data via	2484	This module is required when you want to read or write JSON data via
2268	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2485	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2269	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.	2486	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2270		2487
2271	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2488	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2272	installed.	2489	installed.
2273		2490
2274	=item L<Net::SSLeay>	2491	=item L<Net::SSLeay>
…		…
2341	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2558	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2342		2559
2343	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2560	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2344	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2561	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2345	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2562	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2346	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2563	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2347		2564
2348	Non-blocking file handles, sockets, TCP clients and	2565	Non-blocking file handles, sockets, TCP clients and
2349	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2566	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2350		2567
2351	Asynchronous DNS: L<AnyEvent::DNS>.	2568	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC vs. Revision 1.279 by root, Sun Aug 9 16:05:11 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC vs.
Revision 1.279 by root, Sun Aug 9 16:05:11 2009 UTC