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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.245 by root, Sat Jul 18 05:19:09 2009 UTC vs.
Revision 1.297 by root, Thu Nov 19 01:55:57 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.21';
1059	our $MODEL;	1129	our $MODEL;
1060		1130
1061	our $AUTOLOAD;	1131	our $AUTOLOAD;
1062	our @ISA;	1132	our @ISA;
1063		1133
1064	our @REGISTRY;	1134	our @REGISTRY;
1065
1066	our $WIN32;
1067		1135
1068	our $VERBOSE;	1136	our $VERBOSE;
1069		1137
1070	BEGIN {	1138	BEGIN {
1071	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1139	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
…		…
1088	for reverse split /\s,\s/,	1156	for reverse split /\s,\s/,
1089	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1157	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1090	}	1158	}
1091		1159
1092	my @models = (	1160	my @models = (
1093	[EV:: => AnyEvent::Impl::EV::],	1161	[EV:: => AnyEvent::Impl::EV:: , 1],
1094	[Event:: => AnyEvent::Impl::Event::],
1095	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1162	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1096	# everything below here will not be autoprobed	1163	# everything below here will not (normally) be autoprobed
1097	# as the pureperl backend should work everywhere	1164	# as the pureperl backend should work everywhere
1098	# and is usually faster	1165	# and is usually faster
		1166	[Event:: => AnyEvent::Impl::Event::, 1],
1099	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1167	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1100	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1168	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1169	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1101	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1170	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1102	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1171	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1103	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1172	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1104	[Wx:: => AnyEvent::Impl::POE::],	1173	[Wx:: => AnyEvent::Impl::POE::],
1105	[Prima:: => AnyEvent::Impl::POE::],	1174	[Prima:: => AnyEvent::Impl::POE::],
1106	# IO::Async is just too broken - we would need workarounds for its	1175	# IO::Async is just too broken - we would need workarounds for its
1107	# byzantine signal and broken child handling, among others.	1176	# byzantine signal and broken child handling, among others.
1108	# IO::Async is rather hard to detect, as it doesn't have any	1177	# IO::Async is rather hard to detect, as it doesn't have any
1109	# obvious default class.	1178	# obvious default class.
1110	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1179	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1111	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1180	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1112	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1181	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1182	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1113	);	1183	);
1114		1184
1115	our %method = map +($_ => 1),	1185	our %method = map +($_ => 1),
1116	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1186	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1117		1187
…		…
1121	my ($cb) = @_;	1191	my ($cb) = @_;
1122		1192
1123	if ($MODEL) {	1193	if ($MODEL) {
1124	$cb->();	1194	$cb->();
1125		1195
1126	1	1196	undef
1127	} else {	1197	} else {
1128	push @post_detect, $cb;	1198	push @post_detect, $cb;
1129		1199
1130	defined wantarray	1200	defined wantarray
1131	? bless \$cb, "AnyEvent::Util::postdetect"	1201	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1163	}	1233	}
1164	}	1234	}
1165	}	1235	}
1166		1236
1167	unless ($MODEL) {	1237	unless ($MODEL) {
1168	# try to load a model	1238	# try to autoload a model
1169
1170	for (@REGISTRY, @models) {	1239	for (@REGISTRY, @models) {
1171	my ($package, $model) = @$_;	1240	my ($package, $model, $autoload) = @$_;
		1241	if (
		1242	$autoload
1172	if (eval "require $package"	1243	and eval "require $package"
1173	and ${"$package\::VERSION"} > 0	1244	and ${"$package\::VERSION"} > 0
1174	and eval "require $model") {	1245	and eval "require $model"
		1246	) {
1175	$MODEL = $model;	1247	$MODEL = $model;
1176	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1248	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1177	last;	1249	last;
1178	}	1250	}
1179	}	1251	}
1180		1252
1181	$MODEL	1253	$MODEL
…		…
1222	# we assume CLOEXEC is already set by perl in all important cases	1294	# we assume CLOEXEC is already set by perl in all important cases
1223		1295
1224	($fh2, $rw)	1296	($fh2, $rw)
1225	}	1297	}
1226		1298
		1299	=head1 SIMPLIFIED AE API
		1300
		1301	Starting with version 5.0, AnyEvent officially supports a second, much
		1302	simpler, API that is designed to reduce the calling, typing and memory
		1303	overhead.
		1304
		1305	See the L<AE> manpage for details.
		1306
		1307	=cut
		1308
		1309	package AE;
		1310
		1311	our $VERSION = $AnyEvent::VERSION;
		1312
		1313	sub io($$$) {
		1314	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1315	}
		1316
		1317	sub timer($$$) {
		1318	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1319	}
		1320
		1321	sub signal($$) {
		1322	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1323	}
		1324
		1325	sub child($$) {
		1326	AnyEvent->child (pid => $_[0], cb => $_[1])
		1327	}
		1328
		1329	sub idle($) {
		1330	AnyEvent->idle (cb => $_[0])
		1331	}
		1332
		1333	sub cv(;&) {
		1334	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1335	}
		1336
		1337	sub now() {
		1338	AnyEvent->now
		1339	}
		1340
		1341	sub now_update() {
		1342	AnyEvent->now_update
		1343	}
		1344
		1345	sub time() {
		1346	AnyEvent->time
		1347	}
		1348
1227	package AnyEvent::Base;	1349	package AnyEvent::Base;
1228		1350
1229	# default implementations for many methods	1351	# default implementations for many methods
1230		1352
1231	sub _time {	1353	sub _time() {
1232	# probe for availability of Time::HiRes	1354	# probe for availability of Time::HiRes
1233	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1355	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1234	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1356	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1235	*_time = \&Time::HiRes::time;	1357	*_time = \&Time::HiRes::time;
1236	# if (eval "use POSIX (); (POSIX::times())...	1358	# if (eval "use POSIX (); (POSIX::times())...
…		…
1253	}	1375	}
1254		1376
1255	# default implementation for ->signal	1377	# default implementation for ->signal
1256		1378
1257	our $HAVE_ASYNC_INTERRUPT;	1379	our $HAVE_ASYNC_INTERRUPT;
		1380
		1381	sub _have_async_interrupt() {
		1382	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1383	&& eval "use Async::Interrupt 1.02 (); 1")
		1384	unless defined $HAVE_ASYNC_INTERRUPT;
		1385
		1386	$HAVE_ASYNC_INTERRUPT
		1387	}
		1388
1258	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1389	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1259	our (%SIG_ASY, %SIG_ASY_W);	1390	our (%SIG_ASY, %SIG_ASY_W);
1260	our ($SIG_COUNT, $SIG_TW);	1391	our ($SIG_COUNT, $SIG_TW);
1261		1392
1262	sub _signal_exec {	1393	sub _signal_exec {
1263	$HAVE_ASYNC_INTERRUPT	1394	$HAVE_ASYNC_INTERRUPT
1264	? $SIGPIPE_R->drain	1395	? $SIGPIPE_R->drain
1265	: sysread $SIGPIPE_R, my $dummy, 9;	1396	: sysread $SIGPIPE_R, (my $dummy), 9;
1266		1397
1267	while (%SIG_EV) {	1398	while (%SIG_EV) {
1268	for (keys %SIG_EV) {	1399	for (keys %SIG_EV) {
1269	delete $SIG_EV{$_};	1400	delete $SIG_EV{$_};
1270	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1401	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1271	}	1402	}
1272	}	1403	}
1273	}	1404	}
1274		1405
		1406	# install a dummy wakeup watcher to reduce signal catching latency
1275	sub _signal {	1407	sub _sig_add() {
1276	my (undef, %arg) = @_;	1408	unless ($SIG_COUNT++) {
		1409	# try to align timer on a full-second boundary, if possible
		1410	my $NOW = AE::now;
1277		1411
1278	my $signal = uc $arg{signal}	1412	$SIG_TW = AE::timer
1279	or Carp::croak "required option 'signal' is missing";	1413	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1280		1414	$MAX_SIGNAL_LATENCY,
1281	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1415	sub { } # just for the PERL_ASYNC_CHECK
1282
1283	if ($HAVE_ASYNC_INTERRUPT) {
1284	# async::interrupt
1285
1286	$SIG_ASY{$signal} \|\|= do {
1287	my $asy = new Async::Interrupt
1288	cb => sub { undef $SIG_EV{$signal} },
1289	signal => $signal,
1290	pipe => [$SIGPIPE_R->filenos],
1291	;
1292	$asy->pipe_autodrain (0);
1293
1294	$asy
1295	};	1416	;
1296
1297	} else {
1298	# pure perl
1299
1300	$SIG{$signal} \|\|= sub {
1301	local $!;
1302	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1303	undef $SIG_EV{$signal};
1304	};
1305
1306	# can't do signal processing without introducing races in pure perl,
1307	# so limit the signal latency.
1308	++$SIG_COUNT;
1309	$SIG_TW \|\|= AnyEvent->timer (
1310	after => $MAX_SIGNAL_LATENCY,
1311	interval => $MAX_SIGNAL_LATENCY,
1312	cb => sub { }, # just for the PERL_ASYNC_CHECK
1313	);
1314	}	1417	}
1315
1316	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1317	}	1418	}
1318		1419
1319	sub signal {	1420	sub _sig_del {
1320	# probe for availability of Async::Interrupt
1321	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1322	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1323
1324	$HAVE_ASYNC_INTERRUPT = 1;
1325	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1326	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1327
1328	} else {
1329	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1330
1331	require Fcntl;
1332
1333	if (AnyEvent::WIN32) {
1334	require AnyEvent::Util;
1335
1336	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1337	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1338	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1339	} else {
1340	pipe $SIGPIPE_R, $SIGPIPE_W;
1341	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1342	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1343
1344	# not strictly required, as $^F is normally 2, but let's make sure...
1345	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1346	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1347	}
1348
1349	$SIGPIPE_R
1350	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1351
1352	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1353	}
1354
1355	*signal = \&_signal;
1356	&signal
1357	}
1358
1359	sub AnyEvent::Base::signal::DESTROY {
1360	my ($signal, $cb) = @{$_[0]};
1361
1362	undef $SIG_TW	1421	undef $SIG_TW
1363	unless --$SIG_COUNT;	1422	unless --$SIG_COUNT;
		1423	}
1364		1424
		1425	our $_sig_name_init; $_sig_name_init = sub {
		1426	eval q{ # poor man's autoloading
		1427	undef $_sig_name_init;
		1428
		1429	if (_have_async_interrupt) {
		1430	*sig2num = \&Async::Interrupt::sig2num;
		1431	*sig2name = \&Async::Interrupt::sig2name;
		1432	} else {
		1433	require Config;
		1434
		1435	my %signame2num;
		1436	@signame2num{ split ' ', $Config::Config{sig_name} }
		1437	= split ' ', $Config::Config{sig_num};
		1438
		1439	my @signum2name;
		1440	@signum2name[values %signame2num] = keys %signame2num;
		1441
		1442	*sig2num = sub($) {
		1443	$_[0] > 0 ? shift : $signame2num{+shift}
		1444	};
		1445	*sig2name = sub ($) {
		1446	$_[0] > 0 ? $signum2name[+shift] : shift
		1447	};
		1448	}
		1449	};
		1450	die if $@;
		1451	};
		1452
		1453	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1454	sub sig2name($) { &$_sig_name_init; &sig2name }
		1455
		1456	sub signal {
		1457	eval q{ # poor man's autoloading {}
		1458	# probe for availability of Async::Interrupt
		1459	if (_have_async_interrupt) {
		1460	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1461
		1462	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1463	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1464
		1465	} else {
		1466	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1467
		1468	require Fcntl;
		1469
		1470	if (AnyEvent::WIN32) {
		1471	require AnyEvent::Util;
		1472
		1473	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1474	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1475	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1476	} else {
		1477	pipe $SIGPIPE_R, $SIGPIPE_W;
		1478	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1479	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1480
		1481	# not strictly required, as $^F is normally 2, but let's make sure...
		1482	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1483	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1484	}
		1485
		1486	$SIGPIPE_R
		1487	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1488
		1489	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1490	}
		1491
		1492	*signal = sub {
		1493	my (undef, %arg) = @_;
		1494
		1495	my $signal = uc $arg{signal}
		1496	or Carp::croak "required option 'signal' is missing";
		1497
		1498	if ($HAVE_ASYNC_INTERRUPT) {
		1499	# async::interrupt
		1500
		1501	$signal = sig2num $signal;
		1502	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1503
		1504	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1505	cb => sub { undef $SIG_EV{$signal} },
		1506	signal => $signal,
		1507	pipe => [$SIGPIPE_R->filenos],
		1508	pipe_autodrain => 0,
		1509	;
		1510
		1511	} else {
		1512	# pure perl
		1513
		1514	# AE::Util has been loaded in signal
		1515	$signal = sig2name $signal;
		1516	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1517
		1518	$SIG{$signal} \|\|= sub {
		1519	local $!;
		1520	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1521	undef $SIG_EV{$signal};
		1522	};
		1523
		1524	# can't do signal processing without introducing races in pure perl,
		1525	# so limit the signal latency.
		1526	_sig_add;
		1527	}
		1528
		1529	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1530	};
		1531
		1532	*AnyEvent::Base::signal::DESTROY = sub {
		1533	my ($signal, $cb) = @{$_[0]};
		1534
		1535	_sig_del;
		1536
1365	delete $SIG_CB{$signal}{$cb};	1537	delete $SIG_CB{$signal}{$cb};
1366		1538
1367	$HAVE_ASYNC_INTERRUPT	1539	$HAVE_ASYNC_INTERRUPT
1368	? delete $SIG_ASY{$signal}	1540	? delete $SIG_ASY{$signal}
1369	: # delete doesn't work with older perls - they then	1541	: # delete doesn't work with older perls - they then
1370	# print weird messages, or just unconditionally exit	1542	# print weird messages, or just unconditionally exit
1371	# instead of getting the default action.	1543	# instead of getting the default action.
1372	undef $SIG{$signal}	1544	undef $SIG{$signal}
1373	unless keys %{ $SIG_CB{$signal} };	1545	unless keys %{ $SIG_CB{$signal} };
		1546	};
		1547	};
		1548	die if $@;
		1549	&signal
1374	}	1550	}
1375		1551
1376	# default implementation for ->child	1552	# default implementation for ->child
1377		1553
1378	our %PID_CB;	1554	our %PID_CB;
1379	our $CHLD_W;	1555	our $CHLD_W;
1380	our $CHLD_DELAY_W;	1556	our $CHLD_DELAY_W;
1381	our $WNOHANG;	1557	our $WNOHANG;
1382		1558
		1559	sub _emit_childstatus($$) {
		1560	my (undef, $rpid, $rstatus) = @_;
		1561
		1562	$_->($rpid, $rstatus)
		1563	for values %{ $PID_CB{$rpid} \|\| {} },
		1564	values %{ $PID_CB{0} \|\| {} };
		1565	}
		1566
1383	sub _sigchld {	1567	sub _sigchld {
		1568	my $pid;
		1569
		1570	AnyEvent->_emit_childstatus ($pid, $?)
1384	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1571	while ($pid = waitpid -1, $WNOHANG) > 0;
1385	$_->($pid, $?)
1386	for values %{ $PID_CB{$pid} \|\| {} },
1387	values %{ $PID_CB{0} \|\| {} };
1388	}
1389	}	1572	}
1390		1573
1391	sub child {	1574	sub child {
1392	my (undef, %arg) = @_;	1575	my (undef, %arg) = @_;
1393		1576
…		…
1400	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1583	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1401	? 1	1584	? 1
1402	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1585	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1403		1586
1404	unless ($CHLD_W) {	1587	unless ($CHLD_W) {
1405	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1588	$CHLD_W = AE::signal CHLD => \&_sigchld;
1406	# child could be a zombie already, so make at least one round	1589	# child could be a zombie already, so make at least one round
1407	&_sigchld;	1590	&_sigchld;
1408	}	1591	}
1409		1592
1410	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1593	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1436	# never use more then 50% of the time for the idle watcher,	1619	# never use more then 50% of the time for the idle watcher,
1437	# within some limits	1620	# within some limits
1438	$w = 0.0001 if $w < 0.0001;	1621	$w = 0.0001 if $w < 0.0001;
1439	$w = 5 if $w > 5;	1622	$w = 5 if $w > 5;
1440		1623
1441	$w = AnyEvent->timer (after => $w, cb => $rcb);	1624	$w = AE::timer $w, 0, $rcb;
1442	} else {	1625	} else {
1443	# clean up...	1626	# clean up...
1444	undef $w;	1627	undef $w;
1445	undef $rcb;	1628	undef $rcb;
1446	}	1629	}
1447	};	1630	};
1448		1631
1449	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1632	$w = AE::timer 0.05, 0, $rcb;
1450		1633
1451	bless \\$cb, "AnyEvent::Base::idle"	1634	bless \\$cb, "AnyEvent::Base::idle"
1452	}	1635	}
1453		1636
1454	sub AnyEvent::Base::idle::DESTROY {	1637	sub AnyEvent::Base::idle::DESTROY {
…		…
1508	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1691	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1509	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1692	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1510	}	1693	}
1511		1694
1512	sub cb {	1695	sub cb {
1513	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1696	my $cv = shift;
		1697
		1698	@_
		1699	and $cv->{_ae_cb} = shift
		1700	and $cv->{_ae_sent}
		1701	and (delete $cv->{_ae_cb})->($cv);
		1702
1514	$_[0]{_ae_cb}	1703	$cv->{_ae_cb}
1515	}	1704	}
1516		1705
1517	sub begin {	1706	sub begin {
1518	++$_[0]{_ae_counter};	1707	++$_[0]{_ae_counter};
1519	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1708	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1728	warn "read: $input\n"; # output what has been read	1917	warn "read: $input\n"; # output what has been read
1729	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1918	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1730	},	1919	},
1731	);	1920	);
1732		1921
1733	my $time_watcher; # can only be used once
1734
1735	sub new_timer {
1736	$timer = AnyEvent->timer (after => 1, cb => sub {	1922	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1737	warn "timeout\n"; # print 'timeout' about every second	1923	warn "timeout\n"; # print 'timeout' at most every second
1738	&new_timer; # and restart the time
1739	});	1924	});
1740	}
1741
1742	new_timer; # create first timer
1743		1925
1744	$cv->recv; # wait until user enters /^q/i	1926	$cv->recv; # wait until user enters /^q/i
1745		1927
1746	=head1 REAL-WORLD EXAMPLE	1928	=head1 REAL-WORLD EXAMPLE
1747		1929
…		…
1878	through AnyEvent. The benchmark creates a lot of timers (with a zero	2060	through AnyEvent. The benchmark creates a lot of timers (with a zero
1879	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2061	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1880	which it is), lets them fire exactly once and destroys them again.	2062	which it is), lets them fire exactly once and destroys them again.
1881		2063
1882	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2064	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1883	distribution.	2065	distribution. It uses the L<AE> interface, which makes a real difference
		2066	for the EV and Perl backends only.
1884		2067
1885	=head3 Explanation of the columns	2068	=head3 Explanation of the columns
1886		2069
1887	I<watcher> is the number of event watchers created/destroyed. Since	2070	I<watcher> is the number of event watchers created/destroyed. Since
1888	different event models feature vastly different performances, each event	2071	different event models feature vastly different performances, each event
…		…
1909	watcher.	2092	watcher.
1910		2093
1911	=head3 Results	2094	=head3 Results
1912		2095
1913	name watchers bytes create invoke destroy comment	2096	name watchers bytes create invoke destroy comment
1914	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2097	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1915	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2098	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1916	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2099	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1917	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2100	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1918	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2101	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1919	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2102	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1920	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2103	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1921	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2104	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1922	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2105	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1923	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2106	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1924	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2107	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1925	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2108	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1926		2109
1927	=head3 Discussion	2110	=head3 Discussion
1928		2111
1929	The benchmark does I<not> measure scalability of the event loop very	2112	The benchmark does I<not> measure scalability of the event loop very
1930	well. For example, a select-based event loop (such as the pure perl one)	2113	well. For example, a select-based event loop (such as the pure perl one)
…		…
1942	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2125	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1943	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2126	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1944	cycles with POE.	2127	cycles with POE.
1945		2128
1946	C<EV> is the sole leader regarding speed and memory use, which are both	2129	C<EV> is the sole leader regarding speed and memory use, which are both
1947	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2130	maximal/minimal, respectively. When using the L<AE> API there is zero
		2131	overhead (when going through the AnyEvent API create is about 5-6 times
		2132	slower, with other times being equal, so still uses far less memory than
1948	far less memory than any other event loop and is still faster than Event	2133	any other event loop and is still faster than Event natively).
1949	natively.
1950		2134
1951	The pure perl implementation is hit in a few sweet spots (both the	2135	The pure perl implementation is hit in a few sweet spots (both the
1952	constant timeout and the use of a single fd hit optimisations in the perl	2136	constant timeout and the use of a single fd hit optimisations in the perl
1953	interpreter and the backend itself). Nevertheless this shows that it	2137	interpreter and the backend itself). Nevertheless this shows that it
1954	adds very little overhead in itself. Like any select-based backend its	2138	adds very little overhead in itself. Like any select-based backend its
…		…
2028	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2212	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2029	(1%) are active. This mirrors the activity of large servers with many	2213	(1%) are active. This mirrors the activity of large servers with many
2030	connections, most of which are idle at any one point in time.	2214	connections, most of which are idle at any one point in time.
2031		2215
2032	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2216	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2033	distribution.	2217	distribution. It uses the L<AE> interface, which makes a real difference
		2218	for the EV and Perl backends only.
2034		2219
2035	=head3 Explanation of the columns	2220	=head3 Explanation of the columns
2036		2221
2037	I<sockets> is the number of sockets, and twice the number of "servers" (as	2222	I<sockets> is the number of sockets, and twice the number of "servers" (as
2038	each server has a read and write socket end).	2223	each server has a read and write socket end).
…		…
2046	a new one that moves the timeout into the future.	2231	a new one that moves the timeout into the future.
2047		2232
2048	=head3 Results	2233	=head3 Results
2049		2234
2050	name sockets create request	2235	name sockets create request
2051	EV 20000 69.01 11.16	2236	EV 20000 62.66 7.99
2052	Perl 20000 73.32 35.87	2237	Perl 20000 68.32 32.64
2053	IOAsync 20000 157.00 98.14 epoll	2238	IOAsync 20000 174.06 101.15 epoll
2054	IOAsync 20000 159.31 616.06 poll	2239	IOAsync 20000 174.67 610.84 poll
2055	Event 20000 212.62 257.32	2240	Event 20000 202.69 242.91
2056	Glib 20000 651.16 1896.30	2241	Glib 20000 557.01 1689.52
2057	POE 20000 349.67 12317.24 uses POE::Loop::Event	2242	POE 20000 341.54 12086.32 uses POE::Loop::Event
2058		2243
2059	=head3 Discussion	2244	=head3 Discussion
2060		2245
2061	This benchmark I<does> measure scalability and overall performance of the	2246	This benchmark I<does> measure scalability and overall performance of the
2062	particular event loop.	2247	particular event loop.
…		…
2188	As you can see, the AnyEvent + EV combination even beats the	2373	As you can see, the AnyEvent + EV combination even beats the
2189	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2374	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2190	backend easily beats IO::Lambda and POE.	2375	backend easily beats IO::Lambda and POE.
2191		2376
2192	And even the 100% non-blocking version written using the high-level (and	2377	And even the 100% non-blocking version written using the high-level (and
2193	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2378	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2194	large margin, even though it does all of DNS, tcp-connect and socket I/O	2379	higher level ("unoptimised") abstractions by a large margin, even though
2195	in a non-blocking way.	2380	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2196		2381
2197	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2382	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2198	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2383	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2199	part of the IO::lambda distribution and were used without any changes.	2384	part of the IO::Lambda distribution and were used without any changes.
2200		2385
2201		2386
2202	=head1 SIGNALS	2387	=head1 SIGNALS
2203		2388
2204	AnyEvent currently installs handlers for these signals:	2389	AnyEvent currently installs handlers for these signals:
…		…
2257		2442
2258	This slightly arcane module is used to implement fast signal handling: To	2443	This slightly arcane module is used to implement fast signal handling: To
2259	my knowledge, there is no way to do completely race-free and quick	2444	my knowledge, there is no way to do completely race-free and quick
2260	signal handling in pure perl. To ensure that signals still get	2445	signal handling in pure perl. To ensure that signals still get
2261	delivered, AnyEvent will start an interval timer to wake up perl (and	2446	delivered, AnyEvent will start an interval timer to wake up perl (and
2262	catch the signals) with soemd elay (default is 10 seconds, look for	2447	catch the signals) with some delay (default is 10 seconds, look for
2263	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2448	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2264		2449
2265	If this module is available, then it will be used to implement signal	2450	If this module is available, then it will be used to implement signal
2266	catching, which means that signals will not be delayed, and the event loop	2451	catching, which means that signals will not be delayed, and the event loop
2267	will not be interrupted regularly, which is more efficient (And good for	2452	will not be interrupted regularly, which is more efficient (And good for
2268	battery life on laptops).	2453	battery life on laptops).
2269		2454
2270	This affects not just the pure-perl event loop, but also other event loops	2455	This affects not just the pure-perl event loop, but also other event loops
2271	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2456	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2457
		2458	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2459	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2460	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2461	does nothing for those backends.
2272		2462
2273	=item L<EV>	2463	=item L<EV>
2274		2464
2275	This module isn't really "optional", as it is simply one of the backend	2465	This module isn't really "optional", as it is simply one of the backend
2276	event loops that AnyEvent can use. However, it is simply the best event	2466	event loops that AnyEvent can use. However, it is simply the best event
…		…
2288	lot less memory), but otherwise doesn't affect guard operation much. It is	2478	lot less memory), but otherwise doesn't affect guard operation much. It is
2289	purely used for performance.	2479	purely used for performance.
2290		2480
2291	=item L<JSON> and L<JSON::XS>	2481	=item L<JSON> and L<JSON::XS>
2292		2482
2293	This module is required when you want to read or write JSON data via	2483	One of these modules is required when you want to read or write JSON data
2294	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2484	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2295	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.	2485	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2296		2486
2297	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2487	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2298	installed.	2488	installed.
2299		2489
2300	=item L<Net::SSLeay>	2490	=item L<Net::SSLeay>
…		…
2367	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2557	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2368		2558
2369	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2559	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2370	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2560	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2371	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2561	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2372	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2562	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2373		2563
2374	Non-blocking file handles, sockets, TCP clients and	2564	Non-blocking file handles, sockets, TCP clients and
2375	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2565	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2376		2566
2377	Asynchronous DNS: L<AnyEvent::DNS>.	2567	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.245 by root, Sat Jul 18 05:19:09 2009 UTC vs. Revision 1.297 by root, Thu Nov 19 01:55:57 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.245 by root, Sat Jul 18 05:19:09 2009 UTC vs.
Revision 1.297 by root, Thu Nov 19 01:55:57 2009 UTC