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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.246 by root, Sat Jul 18 15:51:52 2009 UTC vs.
Revision 1.296 by root, Tue Nov 17 01:19:49 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
…		…
341	might affect timers and time-outs.	363	might affect timers and time-outs.
342		364
343	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
344	event loop's idea of "current time".	366	event loop's idea of "current time".
345		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
346	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.
347		376
348	=back	377	=back
349		378
350	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
		380
		381	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351		382
352	You can watch for signals using a signal watcher, C<signal> is the signal	383	You can watch for signals using a signal watcher, C<signal> is the signal
353	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	384	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354	callback to be invoked whenever a signal occurs.	385	callback to be invoked whenever a signal occurs.
355		386
…		…
368		399
369	This watcher might use C<%SIG> (depending on the event loop used),	400	This watcher might use C<%SIG> (depending on the event loop used),
370	so programs overwriting those signals directly will likely not work	401	so programs overwriting those signals directly will likely not work
371	correctly.	402	correctly.
372		403
		404	Example: exit on SIGINT
		405
		406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		407
		408	=head3 Signal Races, Delays and Workarounds
		409
373	Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not	410	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	411	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	412	do race-free signal handling in perl, requiring C libraries for
		413	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	414	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	415	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
378	seconds). This variable can be changed only before the first signal	416	variable can be changed only before the first signal watcher is created,
379	watcher is created, and should be left alone otherwise. Higher values	417	and should be left alone otherwise. This variable determines how often
		418	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	419	will cause fewer spurious wake-ups, which is better for power and CPU
		420	saving.
		421
381	saving. All these problems can be avoided by installing the optional	422	All these problems can be avoided by installing the optional
382	L<Async::Interrupt> module.	423	L<Async::Interrupt> module, which works with most event loops. It will not
383		424	work with inherently broken event loops such as L<Event> or L<Event::Lib>
384	Example: exit on SIGINT	425	(and not with L<POE> currently, as POE does it's own workaround with
385		426	one-second latency). For those, you just have to suffer the delays.
386	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387		427
388	=head2 CHILD PROCESS WATCHERS	428	=head2 CHILD PROCESS WATCHERS
389		429
		430	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		431
390	You can also watch on a child process exit and catch its exit status.	432	You can also watch on a child process exit and catch its exit status.
391		433
392	The child process is specified by the C<pid> argument (if set to C<0>, it	434	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	435	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	436	croak). The watcher will be triggered only when the child process has
395	any trace events (stopped/continued).	437	finished and an exit status is available, not on any trace events
		438	(stopped/continued).
396		439
397	The callback will be called with the pid and exit status (as returned by	440	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	441	waitpid), so unlike other watcher types, you I<can> rely on child watcher
399	callback arguments.	442	callback arguments.
400		443
…		…
441	# do something else, then wait for process exit	484	# do something else, then wait for process exit
442	$done->recv;	485	$done->recv;
443		486
444	=head2 IDLE WATCHERS	487	=head2 IDLE WATCHERS
445		488
		489	$w = AnyEvent->idle (cb => <callback>);
		490
446	Sometimes there is a need to do something, but it is not so important	491	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	492	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	493	"nothing better to do" is usually defined to be "no other events need
449	attention by the event loop".	494	attention by the event loop".
450		495
…		…
476	});	521	});
477	});	522	});
478		523
479	=head2 CONDITION VARIABLES	524	=head2 CONDITION VARIABLES
480		525
		526	$cv = AnyEvent->condvar;
		527
		528	$cv->send (<list>);
		529	my @res = $cv->recv;
		530
481	If you are familiar with some event loops you will know that all of them	531	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	532	require you to run some blocking "loop", "run" or similar function that
483	will actively watch for new events and call your callbacks.	533	will actively watch for new events and call your callbacks.
484		534
485	AnyEvent is slightly different: it expects somebody else to run the event	535	AnyEvent is slightly different: it expects somebody else to run the event
…		…
504	Condition variables are similar to callbacks, except that you can	554	Condition variables are similar to callbacks, except that you can
505	optionally wait for them. They can also be called merge points - points	555	optionally wait for them. They can also be called merge points - points
506	in time where multiple outstanding events have been processed. And yet	556	in time where multiple outstanding events have been processed. And yet
507	another way to call them is transactions - each condition variable can be	557	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	558	used to represent a transaction, which finishes at some point and delivers
509	a result.	559	a result. And yet some people know them as "futures" - a promise to
		560	compute/deliver something that you can wait for.
510		561
511	Condition variables are very useful to signal that something has finished,	562	Condition variables are very useful to signal that something has finished,
512	for example, if you write a module that does asynchronous http requests,	563	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	564	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	565	availability of results. The user can either act when the callback is
…		…
548	after => 1,	599	after => 1,
549	cb => sub { $result_ready->send },	600	cb => sub { $result_ready->send },
550	);	601	);
551		602
552	# this "blocks" (while handling events) till the callback	603	# this "blocks" (while handling events) till the callback
553	# calls -<send	604	# calls ->send
554	$result_ready->recv;	605	$result_ready->recv;
555		606
556	Example: wait for a timer, but take advantage of the fact that condition	607	Example: wait for a timer, but take advantage of the fact that condition
557	variables are also callable directly.	608	variables are also callable directly.
558		609
…		…
622	one. For example, a function that pings many hosts in parallel might want	673	one. For example, a function that pings many hosts in parallel might want
623	to use a condition variable for the whole process.	674	to use a condition variable for the whole process.
624		675
625	Every call to C<< ->begin >> will increment a counter, and every call to	676	Every call to C<< ->begin >> will increment a counter, and every call to
626	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	677	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
627	>>, the (last) callback passed to C<begin> will be executed. That callback	678	>>, the (last) callback passed to C<begin> will be executed, passing the
628	is I<supposed> to call C<< ->send >>, but that is not required. If no	679	condvar as first argument. That callback is I<supposed> to call C<< ->send
629	callback was set, C<send> will be called without any arguments.	680	>>, but that is not required. If no group callback was set, C<send> will
		681	be called without any arguments.
630		682
631	You can think of C<< $cv->send >> giving you an OR condition (one call	683	You can think of C<< $cv->send >> giving you an OR condition (one call
632	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	684	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
633	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	685	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
634		686
…		…
661	begung can potentially be zero:	713	begung can potentially be zero:
662		714
663	my $cv = AnyEvent->condvar;	715	my $cv = AnyEvent->condvar;
664		716
665	my %result;	717	my %result;
666	$cv->begin (sub { $cv->send (\%result) });	718	$cv->begin (sub { shift->send (\%result) });
667		719
668	for my $host (@list_of_hosts) {	720	for my $host (@list_of_hosts) {
669	$cv->begin;	721	$cv->begin;
670	ping_host_then_call_callback $host, sub {	722	ping_host_then_call_callback $host, sub {
671	$result{$host} = ...;	723	$result{$host} = ...;
…		…
746	=item $cb = $cv->cb ($cb->($cv))	798	=item $cb = $cv->cb ($cb->($cv))
747		799
748	This is a mutator function that returns the callback set and optionally	800	This is a mutator function that returns the callback set and optionally
749	replaces it before doing so.	801	replaces it before doing so.
750		802
751	The callback will be called when the condition becomes "true", i.e. when	803	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	804	"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	805	the only argument being the condition variable itself. Calling C<recv>
754	is guaranteed not to block.	806	inside the callback or at any later time is guaranteed not to block.
755		807
756	=back	808	=back
757		809
758	=head1 SUPPORTED EVENT LOOPS/BACKENDS	810	=head1 SUPPORTED EVENT LOOPS/BACKENDS
759		811
…		…
762	=over 4	814	=over 4
763		815
764	=item Backends that are autoprobed when no other event loop can be found.	816	=item Backends that are autoprobed when no other event loop can be found.
765		817
766	EV is the preferred backend when no other event loop seems to be in	818	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	819	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	820	pure-perl implementation, which is available everywhere as it comes with
769	available everywhere as it comes with AnyEvent itself.	821	AnyEvent itself.
770		822
771	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	823	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.	824	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
774		825
775	=item Backends that are transparently being picked up when they are used.	826	=item Backends that are transparently being picked up when they are used.
776		827
777	These will be used when they are currently loaded when the first watcher	828	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	829	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	830	them. This means that AnyEvent will automatically pick the right backend
780	when the main program loads an event module before anything starts to	831	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.	832	create watchers. Nothing special needs to be done by the main program.
782		833
		834	AnyEvent::Impl::Event based on Event, very stable, few glitches.
783	AnyEvent::Impl::Glib based on Glib, slow but very stable.	835	AnyEvent::Impl::Glib based on Glib, slow but very stable.
784	AnyEvent::Impl::Tk based on Tk, very broken.	836	AnyEvent::Impl::Tk based on Tk, very broken.
785	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	837	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786	AnyEvent::Impl::POE based on POE, very slow, some limitations.	838	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		839	AnyEvent::Impl::Irssi used when running within irssi.
787		840
788	=item Backends with special needs.	841	=item Backends with special needs.
789		842
790	Qt requires the Qt::Application to be instantiated first, but will	843	Qt requires the Qt::Application to be instantiated first, but will
791	otherwise be picked up automatically. As long as the main program	844	otherwise be picked up automatically. As long as the main program
…		…
865	event module detection too early, for example, L<AnyEvent::AIO> creates	918	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	919	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867	avoid autodetecting the event module at load time.	920	avoid autodetecting the event module at load time.
868		921
869	If called in scalar or list context, then it creates and returns an object	922	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	923	that automatically removes the callback again when it is destroyed (or
		924	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871	L<Coro::BDB> for a case where this is useful.	925	a case where this is useful.
		926
		927	Example: Create a watcher for the IO::AIO module and store it in
		928	C<$WATCHER>. Only do so after the event loop is initialised, though.
		929
		930	our WATCHER;
		931
		932	my $guard = AnyEvent::post_detect {
		933	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		934	};
		935
		936	# the \|\|= is important in case post_detect immediately runs the block,
		937	# as to not clobber the newly-created watcher. assigning both watcher and
		938	# post_detect guard to the same variable has the advantage of users being
		939	# able to just C<undef $WATCHER> if the watcher causes them grief.
		940
		941	$WATCHER \|\|= $guard;
872		942
873	=item @AnyEvent::post_detect	943	=item @AnyEvent::post_detect
874		944
875	If there are any code references in this array (you can C<push> to it	945	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	946	before or after loading AnyEvent), then they will called directly after
…		…
1043		1113
1044	package AnyEvent;	1114	package AnyEvent;
1045		1115
1046	# basically a tuned-down version of common::sense	1116	# basically a tuned-down version of common::sense
1047	sub common_sense {	1117	sub common_sense {
1048	# no warnings	1118	# from common:.sense 1.0
1049	${^WARNING_BITS} ^= ${^WARNING_BITS};	1119	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1050	# use strict vars subs	1120	# use strict vars subs
1051	$^H \|= 0x00000600;	1121	$^H \|= 0x00000600;
1052	}	1122	}
1053		1123
1054	BEGIN { AnyEvent::common_sense }	1124	BEGIN { AnyEvent::common_sense }
1055		1125
1056	use Carp ();	1126	use Carp ();
1057		1127
1058	our $VERSION = 4.85;	1128	our $VERSION = '5.202';
1059	our $MODEL;	1129	our $MODEL;
1060		1130
1061	our $AUTOLOAD;	1131	our $AUTOLOAD;
1062	our @ISA;	1132	our @ISA;
1063		1133
…		…
1088	for reverse split /\s,\s/,	1158	for reverse split /\s,\s/,
1089	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1159	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1090	}	1160	}
1091		1161
1092	my @models = (	1162	my @models = (
1093	[EV:: => AnyEvent::Impl::EV::],	1163	[EV:: => AnyEvent::Impl::EV:: , 1],
1094	[Event:: => AnyEvent::Impl::Event::],
1095	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1164	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1096	# everything below here will not be autoprobed	1165	# everything below here will not (normally) be autoprobed
1097	# as the pureperl backend should work everywhere	1166	# as the pureperl backend should work everywhere
1098	# and is usually faster	1167	# and is usually faster
		1168	[Event:: => AnyEvent::Impl::Event::, 1],
1099	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1169	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1100	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1170	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1171	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1101	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1172	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1102	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1173	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1103	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1174	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1104	[Wx:: => AnyEvent::Impl::POE::],	1175	[Wx:: => AnyEvent::Impl::POE::],
1105	[Prima:: => AnyEvent::Impl::POE::],	1176	[Prima:: => AnyEvent::Impl::POE::],
1106	# IO::Async is just too broken - we would need workarounds for its	1177	# IO::Async is just too broken - we would need workarounds for its
1107	# byzantine signal and broken child handling, among others.	1178	# byzantine signal and broken child handling, among others.
1108	# IO::Async is rather hard to detect, as it doesn't have any	1179	# IO::Async is rather hard to detect, as it doesn't have any
1109	# obvious default class.	1180	# obvious default class.
1110	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1181	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1111	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1182	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1112	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1183	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1184	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1113	);	1185	);
1114		1186
1115	our %method = map +($_ => 1),	1187	our %method = map +($_ => 1),
1116	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1188	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1117		1189
…		…
1121	my ($cb) = @_;	1193	my ($cb) = @_;
1122		1194
1123	if ($MODEL) {	1195	if ($MODEL) {
1124	$cb->();	1196	$cb->();
1125		1197
1126	1	1198	undef
1127	} else {	1199	} else {
1128	push @post_detect, $cb;	1200	push @post_detect, $cb;
1129		1201
1130	defined wantarray	1202	defined wantarray
1131	? bless \$cb, "AnyEvent::Util::postdetect"	1203	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1163	}	1235	}
1164	}	1236	}
1165	}	1237	}
1166		1238
1167	unless ($MODEL) {	1239	unless ($MODEL) {
1168	# try to load a model	1240	# try to autoload a model
1169
1170	for (@REGISTRY, @models) {	1241	for (@REGISTRY, @models) {
1171	my ($package, $model) = @$_;	1242	my ($package, $model, $autoload) = @$_;
		1243	if (
		1244	$autoload
1172	if (eval "require $package"	1245	and eval "require $package"
1173	and ${"$package\::VERSION"} > 0	1246	and ${"$package\::VERSION"} > 0
1174	and eval "require $model") {	1247	and eval "require $model"
		1248	) {
1175	$MODEL = $model;	1249	$MODEL = $model;
1176	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1250	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1177	last;	1251	last;
1178	}	1252	}
1179	}	1253	}
1180		1254
1181	$MODEL	1255	$MODEL
…		…
1222	# we assume CLOEXEC is already set by perl in all important cases	1296	# we assume CLOEXEC is already set by perl in all important cases
1223		1297
1224	($fh2, $rw)	1298	($fh2, $rw)
1225	}	1299	}
1226		1300
		1301	=head1 SIMPLIFIED AE API
		1302
		1303	Starting with version 5.0, AnyEvent officially supports a second, much
		1304	simpler, API that is designed to reduce the calling, typing and memory
		1305	overhead.
		1306
		1307	See the L<AE> manpage for details.
		1308
		1309	=cut
		1310
		1311	package AE;
		1312
		1313	our $VERSION = $AnyEvent::VERSION;
		1314
		1315	sub io($$$) {
		1316	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1317	}
		1318
		1319	sub timer($$$) {
		1320	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1321	}
		1322
		1323	sub signal($$) {
		1324	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1325	}
		1326
		1327	sub child($$) {
		1328	AnyEvent->child (pid => $_[0], cb => $_[1])
		1329	}
		1330
		1331	sub idle($) {
		1332	AnyEvent->idle (cb => $_[0])
		1333	}
		1334
		1335	sub cv(;&) {
		1336	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1337	}
		1338
		1339	sub now() {
		1340	AnyEvent->now
		1341	}
		1342
		1343	sub now_update() {
		1344	AnyEvent->now_update
		1345	}
		1346
		1347	sub time() {
		1348	AnyEvent->time
		1349	}
		1350
1227	package AnyEvent::Base;	1351	package AnyEvent::Base;
1228		1352
1229	# default implementations for many methods	1353	# default implementations for many methods
1230		1354
1231	sub _time {	1355	sub _time() {
1232	# probe for availability of Time::HiRes	1356	# probe for availability of Time::HiRes
1233	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1357	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1234	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1358	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1235	*_time = \&Time::HiRes::time;	1359	*_time = \&Time::HiRes::time;
1236	# if (eval "use POSIX (); (POSIX::times())...	1360	# if (eval "use POSIX (); (POSIX::times())...
…		…
1253	}	1377	}
1254		1378
1255	# default implementation for ->signal	1379	# default implementation for ->signal
1256		1380
1257	our $HAVE_ASYNC_INTERRUPT;	1381	our $HAVE_ASYNC_INTERRUPT;
		1382
		1383	sub _have_async_interrupt() {
		1384	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1385	&& eval "use Async::Interrupt 1.02 (); 1")
		1386	unless defined $HAVE_ASYNC_INTERRUPT;
		1387
		1388	$HAVE_ASYNC_INTERRUPT
		1389	}
		1390
1258	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1391	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1259	our (%SIG_ASY, %SIG_ASY_W);	1392	our (%SIG_ASY, %SIG_ASY_W);
1260	our ($SIG_COUNT, $SIG_TW);	1393	our ($SIG_COUNT, $SIG_TW);
1261		1394
1262	sub _signal_exec {	1395	sub _signal_exec {
1263	$HAVE_ASYNC_INTERRUPT	1396	$HAVE_ASYNC_INTERRUPT
1264	? $SIGPIPE_R->drain	1397	? $SIGPIPE_R->drain
1265	: sysread $SIGPIPE_R, my $dummy, 9;	1398	: sysread $SIGPIPE_R, (my $dummy), 9;
1266		1399
1267	while (%SIG_EV) {	1400	while (%SIG_EV) {
1268	for (keys %SIG_EV) {	1401	for (keys %SIG_EV) {
1269	delete $SIG_EV{$_};	1402	delete $SIG_EV{$_};
1270	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1403	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1271	}	1404	}
1272	}	1405	}
1273	}	1406	}
1274		1407
1275	# install a dumym wakeupw atcher to reduce signal catching latency	1408	# install a dummy wakeup watcher to reduce signal catching latency
1276	sub _sig_add() {	1409	sub _sig_add() {
1277	unless ($SIG_COUNT++) {	1410	unless ($SIG_COUNT++) {
1278	# try to align timer on a full-second boundary, if possible	1411	# try to align timer on a full-second boundary, if possible
1279	my $NOW = AnyEvent->now;	1412	my $NOW = AE::now;
1280		1413
1281	$SIG_TW = AnyEvent->timer (	1414	$SIG_TW = AE::timer
1282	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1415	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1283	interval => $MAX_SIGNAL_LATENCY,	1416	$MAX_SIGNAL_LATENCY,
1284	cb => sub { }, # just for the PERL_ASYNC_CHECK	1417	sub { } # just for the PERL_ASYNC_CHECK
1285	);	1418	;
1286	}	1419	}
1287	}	1420	}
1288		1421
1289	sub _sig_del {	1422	sub _sig_del {
1290	undef $SIG_TW	1423	undef $SIG_TW
1291	unless --$SIG_COUNT;	1424	unless --$SIG_COUNT;
1292	}	1425	}
1293		1426
		1427	our $_sig_name_init; $_sig_name_init = sub {
		1428	eval q{ # poor man's autoloading
		1429	undef $_sig_name_init;
		1430
		1431	if (_have_async_interrupt) {
		1432	*sig2num = \&Async::Interrupt::sig2num;
		1433	*sig2name = \&Async::Interrupt::sig2name;
		1434	} else {
		1435	require Config;
		1436
		1437	my %signame2num;
		1438	@signame2num{ split ' ', $Config::Config{sig_name} }
		1439	= split ' ', $Config::Config{sig_num};
		1440
		1441	my @signum2name;
		1442	@signum2name[values %signame2num] = keys %signame2num;
		1443
		1444	*sig2num = sub($) {
		1445	$_[0] > 0 ? shift : $signame2num{+shift}
		1446	};
		1447	*sig2name = sub ($) {
		1448	$_[0] > 0 ? $signum2name[+shift] : shift
		1449	};
		1450	}
		1451	};
		1452	die if $@;
		1453	};
		1454
		1455	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1456	sub sig2name($) { &$_sig_name_init; &sig2name }
		1457
1294	sub _signal {	1458	sub signal {
		1459	eval q{ # poor man's autoloading {}
		1460	# probe for availability of Async::Interrupt
		1461	if (_have_async_interrupt) {
		1462	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1463
		1464	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1465	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1466
		1467	} else {
		1468	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1469
		1470	require Fcntl;
		1471
		1472	if (AnyEvent::WIN32) {
		1473	require AnyEvent::Util;
		1474
		1475	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1476	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1477	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1478	} else {
		1479	pipe $SIGPIPE_R, $SIGPIPE_W;
		1480	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1481	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1482
		1483	# not strictly required, as $^F is normally 2, but let's make sure...
		1484	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1485	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1486	}
		1487
		1488	$SIGPIPE_R
		1489	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1490
		1491	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1492	}
		1493
		1494	*signal = sub {
1295	my (undef, %arg) = @_;	1495	my (undef, %arg) = @_;
1296		1496
1297	my $signal = uc $arg{signal}	1497	my $signal = uc $arg{signal}
1298	or Carp::croak "required option 'signal' is missing";	1498	or Carp::croak "required option 'signal' is missing";
1299		1499
1300	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1301
1302	if ($HAVE_ASYNC_INTERRUPT) {	1500	if ($HAVE_ASYNC_INTERRUPT) {
1303	# async::interrupt	1501	# async::interrupt
1304		1502
1305	$SIG_ASY{$signal} \|\|= do {	1503	$signal = sig2num $signal;
1306	my $asy = new Async::Interrupt	1504	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1505
		1506	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1307	cb => sub { undef $SIG_EV{$signal} },	1507	cb => sub { undef $SIG_EV{$signal} },
1308	signal => $signal,	1508	signal => $signal,
1309	pipe => [$SIGPIPE_R->filenos],	1509	pipe => [$SIGPIPE_R->filenos],
		1510	pipe_autodrain => 0,
		1511	;
		1512
		1513	} else {
		1514	# pure perl
		1515
		1516	# AE::Util has been loaded in signal
		1517	$signal = sig2name $signal;
		1518	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1519
		1520	$SIG{$signal} \|\|= sub {
		1521	local $!;
		1522	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1523	undef $SIG_EV{$signal};
		1524	};
		1525
		1526	# can't do signal processing without introducing races in pure perl,
		1527	# so limit the signal latency.
		1528	_sig_add;
1310	;	1529	}
1311	$asy->pipe_autodrain (0);
1312		1530
1313	$asy	1531	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1314	};	1532	};
1315		1533
1316	} else {	1534	*AnyEvent::Base::signal::DESTROY = sub {
1317	# pure perl	1535	my ($signal, $cb) = @{$_[0]};
1318		1536
1319	$SIG{$signal} \|\|= sub {	1537	_sig_del;
1320	local $!;	1538
1321	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1539	delete $SIG_CB{$signal}{$cb};
		1540
		1541	$HAVE_ASYNC_INTERRUPT
		1542	? delete $SIG_ASY{$signal}
		1543	: # delete doesn't work with older perls - they then
		1544	# print weird messages, or just unconditionally exit
		1545	# instead of getting the default action.
1322	undef $SIG_EV{$signal};	1546	undef $SIG{$signal}
		1547	unless keys %{ $SIG_CB{$signal} };
1323	};	1548	};
1324
1325	# can't do signal processing without introducing races in pure perl,
1326	# so limit the signal latency.
1327	_sig_add;
1328	}	1549	};
1329		1550	die if $@;
1330	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1331	}
1332
1333	sub signal {
1334	# probe for availability of Async::Interrupt
1335	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1336	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1337
1338	$HAVE_ASYNC_INTERRUPT = 1;
1339	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1340	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1341
1342	} else {
1343	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1344
1345	require Fcntl;
1346
1347	if (AnyEvent::WIN32) {
1348	require AnyEvent::Util;
1349
1350	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1351	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1352	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1353	} else {
1354	pipe $SIGPIPE_R, $SIGPIPE_W;
1355	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1356	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1357
1358	# not strictly required, as $^F is normally 2, but let's make sure...
1359	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1360	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1361	}
1362
1363	$SIGPIPE_R
1364	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1365
1366	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1367	}
1368
1369	*signal = \&_signal;
1370	&signal	1551	&signal
1371	}
1372
1373	sub AnyEvent::Base::signal::DESTROY {
1374	my ($signal, $cb) = @{$_[0]};
1375
1376	_sig_del;
1377
1378	delete $SIG_CB{$signal}{$cb};
1379
1380	$HAVE_ASYNC_INTERRUPT
1381	? delete $SIG_ASY{$signal}
1382	: # delete doesn't work with older perls - they then
1383	# print weird messages, or just unconditionally exit
1384	# instead of getting the default action.
1385	undef $SIG{$signal}
1386	unless keys %{ $SIG_CB{$signal} };
1387	}	1552	}
1388		1553
1389	# default implementation for ->child	1554	# default implementation for ->child
1390		1555
1391	our %PID_CB;	1556	our %PID_CB;
1392	our $CHLD_W;	1557	our $CHLD_W;
1393	our $CHLD_DELAY_W;	1558	our $CHLD_DELAY_W;
1394	our $WNOHANG;	1559	our $WNOHANG;
1395		1560
		1561	sub _emit_childstatus($$) {
		1562	my (undef, $rpid, $rstatus) = @_;
		1563
		1564	$_->($rpid, $rstatus)
		1565	for values %{ $PID_CB{$rpid} \|\| {} },
		1566	values %{ $PID_CB{0} \|\| {} };
		1567	}
		1568
1396	sub _sigchld {	1569	sub _sigchld {
		1570	my $pid;
		1571
		1572	AnyEvent->_emit_childstatus ($pid, $?)
1397	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1573	while ($pid = waitpid -1, $WNOHANG) > 0;
1398	$_->($pid, $?)
1399	for values %{ $PID_CB{$pid} \|\| {} },
1400	values %{ $PID_CB{0} \|\| {} };
1401	}
1402	}	1574	}
1403		1575
1404	sub child {	1576	sub child {
1405	my (undef, %arg) = @_;	1577	my (undef, %arg) = @_;
1406		1578
…		…
1413	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1585	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1414	? 1	1586	? 1
1415	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1587	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1416		1588
1417	unless ($CHLD_W) {	1589	unless ($CHLD_W) {
1418	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1590	$CHLD_W = AE::signal CHLD => \&_sigchld;
1419	# child could be a zombie already, so make at least one round	1591	# child could be a zombie already, so make at least one round
1420	&_sigchld;	1592	&_sigchld;
1421	}	1593	}
1422		1594
1423	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1595	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1449	# never use more then 50% of the time for the idle watcher,	1621	# never use more then 50% of the time for the idle watcher,
1450	# within some limits	1622	# within some limits
1451	$w = 0.0001 if $w < 0.0001;	1623	$w = 0.0001 if $w < 0.0001;
1452	$w = 5 if $w > 5;	1624	$w = 5 if $w > 5;
1453		1625
1454	$w = AnyEvent->timer (after => $w, cb => $rcb);	1626	$w = AE::timer $w, 0, $rcb;
1455	} else {	1627	} else {
1456	# clean up...	1628	# clean up...
1457	undef $w;	1629	undef $w;
1458	undef $rcb;	1630	undef $rcb;
1459	}	1631	}
1460	};	1632	};
1461		1633
1462	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1634	$w = AE::timer 0.05, 0, $rcb;
1463		1635
1464	bless \\$cb, "AnyEvent::Base::idle"	1636	bless \\$cb, "AnyEvent::Base::idle"
1465	}	1637	}
1466		1638
1467	sub AnyEvent::Base::idle::DESTROY {	1639	sub AnyEvent::Base::idle::DESTROY {
…		…
1521	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1693	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1522	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1694	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1523	}	1695	}
1524		1696
1525	sub cb {	1697	sub cb {
1526	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1698	my $cv = shift;
		1699
		1700	@_
		1701	and $cv->{_ae_cb} = shift
		1702	and $cv->{_ae_sent}
		1703	and (delete $cv->{_ae_cb})->($cv);
		1704
1527	$_[0]{_ae_cb}	1705	$cv->{_ae_cb}
1528	}	1706	}
1529		1707
1530	sub begin {	1708	sub begin {
1531	++$_[0]{_ae_counter};	1709	++$_[0]{_ae_counter};
1532	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1710	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1741	warn "read: $input\n"; # output what has been read	1919	warn "read: $input\n"; # output what has been read
1742	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1920	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1743	},	1921	},
1744	);	1922	);
1745		1923
1746	my $time_watcher; # can only be used once
1747
1748	sub new_timer {
1749	$timer = AnyEvent->timer (after => 1, cb => sub {	1924	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1750	warn "timeout\n"; # print 'timeout' about every second	1925	warn "timeout\n"; # print 'timeout' at most every second
1751	&new_timer; # and restart the time
1752	});	1926	});
1753	}
1754
1755	new_timer; # create first timer
1756		1927
1757	$cv->recv; # wait until user enters /^q/i	1928	$cv->recv; # wait until user enters /^q/i
1758		1929
1759	=head1 REAL-WORLD EXAMPLE	1930	=head1 REAL-WORLD EXAMPLE
1760		1931
…		…
1891	through AnyEvent. The benchmark creates a lot of timers (with a zero	2062	through AnyEvent. The benchmark creates a lot of timers (with a zero
1892	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2063	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1893	which it is), lets them fire exactly once and destroys them again.	2064	which it is), lets them fire exactly once and destroys them again.
1894		2065
1895	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2066	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1896	distribution.	2067	distribution. It uses the L<AE> interface, which makes a real difference
		2068	for the EV and Perl backends only.
1897		2069
1898	=head3 Explanation of the columns	2070	=head3 Explanation of the columns
1899		2071
1900	I<watcher> is the number of event watchers created/destroyed. Since	2072	I<watcher> is the number of event watchers created/destroyed. Since
1901	different event models feature vastly different performances, each event	2073	different event models feature vastly different performances, each event
…		…
1922	watcher.	2094	watcher.
1923		2095
1924	=head3 Results	2096	=head3 Results
1925		2097
1926	name watchers bytes create invoke destroy comment	2098	name watchers bytes create invoke destroy comment
1927	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2099	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1928	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2100	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1929	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2101	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1930	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2102	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1931	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2103	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1932	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2104	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1933	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2105	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1934	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2106	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1935	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2107	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1936	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2108	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1937	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2109	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1938	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2110	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1939		2111
1940	=head3 Discussion	2112	=head3 Discussion
1941		2113
1942	The benchmark does I<not> measure scalability of the event loop very	2114	The benchmark does I<not> measure scalability of the event loop very
1943	well. For example, a select-based event loop (such as the pure perl one)	2115	well. For example, a select-based event loop (such as the pure perl one)
…		…
1955	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2127	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1956	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2128	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1957	cycles with POE.	2129	cycles with POE.
1958		2130
1959	C<EV> is the sole leader regarding speed and memory use, which are both	2131	C<EV> is the sole leader regarding speed and memory use, which are both
1960	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2132	maximal/minimal, respectively. When using the L<AE> API there is zero
		2133	overhead (when going through the AnyEvent API create is about 5-6 times
		2134	slower, with other times being equal, so still uses far less memory than
1961	far less memory than any other event loop and is still faster than Event	2135	any other event loop and is still faster than Event natively).
1962	natively.
1963		2136
1964	The pure perl implementation is hit in a few sweet spots (both the	2137	The pure perl implementation is hit in a few sweet spots (both the
1965	constant timeout and the use of a single fd hit optimisations in the perl	2138	constant timeout and the use of a single fd hit optimisations in the perl
1966	interpreter and the backend itself). Nevertheless this shows that it	2139	interpreter and the backend itself). Nevertheless this shows that it
1967	adds very little overhead in itself. Like any select-based backend its	2140	adds very little overhead in itself. Like any select-based backend its
…		…
2041	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2214	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2042	(1%) are active. This mirrors the activity of large servers with many	2215	(1%) are active. This mirrors the activity of large servers with many
2043	connections, most of which are idle at any one point in time.	2216	connections, most of which are idle at any one point in time.
2044		2217
2045	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2218	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2046	distribution.	2219	distribution. It uses the L<AE> interface, which makes a real difference
		2220	for the EV and Perl backends only.
2047		2221
2048	=head3 Explanation of the columns	2222	=head3 Explanation of the columns
2049		2223
2050	I<sockets> is the number of sockets, and twice the number of "servers" (as	2224	I<sockets> is the number of sockets, and twice the number of "servers" (as
2051	each server has a read and write socket end).	2225	each server has a read and write socket end).
…		…
2059	a new one that moves the timeout into the future.	2233	a new one that moves the timeout into the future.
2060		2234
2061	=head3 Results	2235	=head3 Results
2062		2236
2063	name sockets create request	2237	name sockets create request
2064	EV 20000 69.01 11.16	2238	EV 20000 62.66 7.99
2065	Perl 20000 73.32 35.87	2239	Perl 20000 68.32 32.64
2066	IOAsync 20000 157.00 98.14 epoll	2240	IOAsync 20000 174.06 101.15 epoll
2067	IOAsync 20000 159.31 616.06 poll	2241	IOAsync 20000 174.67 610.84 poll
2068	Event 20000 212.62 257.32	2242	Event 20000 202.69 242.91
2069	Glib 20000 651.16 1896.30	2243	Glib 20000 557.01 1689.52
2070	POE 20000 349.67 12317.24 uses POE::Loop::Event	2244	POE 20000 341.54 12086.32 uses POE::Loop::Event
2071		2245
2072	=head3 Discussion	2246	=head3 Discussion
2073		2247
2074	This benchmark I<does> measure scalability and overall performance of the	2248	This benchmark I<does> measure scalability and overall performance of the
2075	particular event loop.	2249	particular event loop.
…		…
2201	As you can see, the AnyEvent + EV combination even beats the	2375	As you can see, the AnyEvent + EV combination even beats the
2202	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2376	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2203	backend easily beats IO::Lambda and POE.	2377	backend easily beats IO::Lambda and POE.
2204		2378
2205	And even the 100% non-blocking version written using the high-level (and	2379	And even the 100% non-blocking version written using the high-level (and
2206	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2380	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2207	large margin, even though it does all of DNS, tcp-connect and socket I/O	2381	higher level ("unoptimised") abstractions by a large margin, even though
2208	in a non-blocking way.	2382	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2209		2383
2210	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2384	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2211	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2385	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2212	part of the IO::lambda distribution and were used without any changes.	2386	part of the IO::Lambda distribution and were used without any changes.
2213		2387
2214		2388
2215	=head1 SIGNALS	2389	=head1 SIGNALS
2216		2390
2217	AnyEvent currently installs handlers for these signals:	2391	AnyEvent currently installs handlers for these signals:
…		…
2270		2444
2271	This slightly arcane module is used to implement fast signal handling: To	2445	This slightly arcane module is used to implement fast signal handling: To
2272	my knowledge, there is no way to do completely race-free and quick	2446	my knowledge, there is no way to do completely race-free and quick
2273	signal handling in pure perl. To ensure that signals still get	2447	signal handling in pure perl. To ensure that signals still get
2274	delivered, AnyEvent will start an interval timer to wake up perl (and	2448	delivered, AnyEvent will start an interval timer to wake up perl (and
2275	catch the signals) with soemd elay (default is 10 seconds, look for	2449	catch the signals) with some delay (default is 10 seconds, look for
2276	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2450	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2277		2451
2278	If this module is available, then it will be used to implement signal	2452	If this module is available, then it will be used to implement signal
2279	catching, which means that signals will not be delayed, and the event loop	2453	catching, which means that signals will not be delayed, and the event loop
2280	will not be interrupted regularly, which is more efficient (And good for	2454	will not be interrupted regularly, which is more efficient (And good for
2281	battery life on laptops).	2455	battery life on laptops).
2282		2456
2283	This affects not just the pure-perl event loop, but also other event loops	2457	This affects not just the pure-perl event loop, but also other event loops
2284	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2458	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2459
		2460	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2461	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2462	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2463	does nothing for those backends.
2285		2464
2286	=item L<EV>	2465	=item L<EV>
2287		2466
2288	This module isn't really "optional", as it is simply one of the backend	2467	This module isn't really "optional", as it is simply one of the backend
2289	event loops that AnyEvent can use. However, it is simply the best event	2468	event loops that AnyEvent can use. However, it is simply the best event
…		…
2301	lot less memory), but otherwise doesn't affect guard operation much. It is	2480	lot less memory), but otherwise doesn't affect guard operation much. It is
2302	purely used for performance.	2481	purely used for performance.
2303		2482
2304	=item L<JSON> and L<JSON::XS>	2483	=item L<JSON> and L<JSON::XS>
2305		2484
2306	This module is required when you want to read or write JSON data via	2485	One of these modules is required when you want to read or write JSON data
2307	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2486	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2308	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.	2487	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2309		2488
2310	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2489	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2311	installed.	2490	installed.
2312		2491
2313	=item L<Net::SSLeay>	2492	=item L<Net::SSLeay>
…		…
2380	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2559	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2381		2560
2382	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2561	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2383	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2562	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2384	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2563	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2385	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2564	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2386		2565
2387	Non-blocking file handles, sockets, TCP clients and	2566	Non-blocking file handles, sockets, TCP clients and
2388	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2567	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2389		2568
2390	Asynchronous DNS: L<AnyEvent::DNS>.	2569	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.246 by root, Sat Jul 18 15:51:52 2009 UTC vs. Revision 1.296 by root, Tue Nov 17 01:19:49 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.246 by root, Sat Jul 18 15:51:52 2009 UTC vs.
Revision 1.296 by root, Tue Nov 17 01:19:49 2009 UTC