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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.251 by root, Mon Jul 20 22:39:57 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 - events independent of event loop implementation	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
47		47
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	48	There is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	49	channel, too.
50		50
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Respository>, at L<http://anyevent.schmorp.de>, for more info.	52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		53
54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55		55
56	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
57	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
181	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
182	declared.	182	declared.
183		183
184	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
185		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
186	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
187	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
188		194
189	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
190	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
…		…
219	undef $w;	225	undef $w;
220	});	226	});
221		227
222	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
223		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
224	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 >>
225	method with the following mandatory arguments:	239	method with the following mandatory arguments:
226		240
227	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
228	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
…		…
349	might affect timers and time-outs.	363	might affect timers and time-outs.
350		364
351	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
352	event loop's idea of "current time".	366	event loop's idea of "current time".
353		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
354	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.
355		376
356	=back	377	=back
357		378
358	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
		380
		381	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359		382
360	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
361	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
362	callback to be invoked whenever a signal occurs.	385	callback to be invoked whenever a signal occurs.
363		386
…		…
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		407
385	=head3 Signal Races, Delays and Workarounds	408	=head3 Signal Races, Delays and Workarounds
386		409
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	410	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388	callbacks to signals in a generic way, which is a pity, as you cannot do	411	callbacks to signals in a generic way, which is a pity, as you cannot
389	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,
390	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
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	415	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	416	variable can be changed only before the first signal watcher is created,
393	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
394	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
395	saving. All these problems can be avoided by installing the optional	422	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	423	L<Async::Interrupt> module, which works with most event loops. It will not
397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	424	work with inherently broken event loops such as L<Event> or L<Event::Lib>
398	currently, as POE does it's own workaround with one-second latency). With	425	(and not with L<POE> currently, as POE does it's own workaround with
399	those, you just have to suffer the delays.	426	one-second latency). For those, you just have to suffer the delays.
400		427
401	=head2 CHILD PROCESS WATCHERS	428	=head2 CHILD PROCESS WATCHERS
402		429
		430	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		431
403	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.
404		433
405	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,
406	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
407	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
408	any trace events (stopped/continued).	437	finished and an exit status is available, not on any trace events
		438	(stopped/continued).
409		439
410	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
411	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
412	callback arguments.	442	callback arguments.
413		443
…		…
454	# do something else, then wait for process exit	484	# do something else, then wait for process exit
455	$done->recv;	485	$done->recv;
456		486
457	=head2 IDLE WATCHERS	487	=head2 IDLE WATCHERS
458		488
		489	$w = AnyEvent->idle (cb => <callback>);
		490
459	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
460	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
461	"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
462	attention by the event loop".	494	attention by the event loop".
463		495
…		…
489	});	521	});
490	});	522	});
491		523
492	=head2 CONDITION VARIABLES	524	=head2 CONDITION VARIABLES
493		525
		526	$cv = AnyEvent->condvar;
		527
		528	$cv->send (<list>);
		529	my @res = $cv->recv;
		530
494	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
495	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
496	will actively watch for new events and call your callbacks.	533	will actively watch for new events and call your callbacks.
497		534
498	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
…		…
562	after => 1,	599	after => 1,
563	cb => sub { $result_ready->send },	600	cb => sub { $result_ready->send },
564	);	601	);
565		602
566	# this "blocks" (while handling events) till the callback	603	# this "blocks" (while handling events) till the callback
567	# calls -<send	604	# calls ->send
568	$result_ready->recv;	605	$result_ready->recv;
569		606
570	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
571	variables are also callable directly.	608	variables are also callable directly.
572		609
…		…
636	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
637	to use a condition variable for the whole process.	674	to use a condition variable for the whole process.
638		675
639	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
640	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
641	>>, 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
642	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
643	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.
644		682
645	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
646	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
647	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).
648		686
…		…
675	begung can potentially be zero:	713	begung can potentially be zero:
676		714
677	my $cv = AnyEvent->condvar;	715	my $cv = AnyEvent->condvar;
678		716
679	my %result;	717	my %result;
680	$cv->begin (sub { $cv->send (\%result) });	718	$cv->begin (sub { shift->send (\%result) });
681		719
682	for my $host (@list_of_hosts) {	720	for my $host (@list_of_hosts) {
683	$cv->begin;	721	$cv->begin;
684	ping_host_then_call_callback $host, sub {	722	ping_host_then_call_callback $host, sub {
685	$result{$host} = ...;	723	$result{$host} = ...;
…		…
760	=item $cb = $cv->cb ($cb->($cv))	798	=item $cb = $cv->cb ($cb->($cv))
761		799
762	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
763	replaces it before doing so.	801	replaces it before doing so.
764		802
765	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)
766	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
767	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>
768	is guaranteed not to block.	806	inside the callback or at any later time is guaranteed not to block.
769		807
770	=back	808	=back
771		809
772	=head1 SUPPORTED EVENT LOOPS/BACKENDS	810	=head1 SUPPORTED EVENT LOOPS/BACKENDS
773		811
…		…
776	=over 4	814	=over 4
777		815
778	=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.
779		817
780	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
781	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
782	that, will fall back to its own pure-perl implementation, which is	820	pure-perl implementation, which is available everywhere as it comes with
783	available everywhere as it comes with AnyEvent itself.	821	AnyEvent itself.
784		822
785	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	823	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
786	AnyEvent::Impl::Event based on Event, very stable, few glitches.
787	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	824	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
788		825
789	=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.
790		827
791	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
792	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
793	them. This means that AnyEvent will automatically pick the right backend	830	them. This means that AnyEvent will automatically pick the right backend
794	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
795	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.
796		833
		834	AnyEvent::Impl::Event based on Event, very stable, few glitches.
797	AnyEvent::Impl::Glib based on Glib, slow but very stable.	835	AnyEvent::Impl::Glib based on Glib, slow but very stable.
798	AnyEvent::Impl::Tk based on Tk, very broken.	836	AnyEvent::Impl::Tk based on Tk, very broken.
799	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	837	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
800	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.
801		840
802	=item Backends with special needs.	841	=item Backends with special needs.
803		842
804	Qt requires the Qt::Application to be instantiated first, but will	843	Qt requires the Qt::Application to be instantiated first, but will
805	otherwise be picked up automatically. As long as the main program	844	otherwise be picked up automatically. As long as the main program
…		…
879	event module detection too early, for example, L<AnyEvent::AIO> creates	918	event module detection too early, for example, L<AnyEvent::AIO> creates
880	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
881	avoid autodetecting the event module at load time.	920	avoid autodetecting the event module at load time.
882		921
883	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
884	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
885	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;
886		942
887	=item @AnyEvent::post_detect	943	=item @AnyEvent::post_detect
888		944
889	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
890	before or after loading AnyEvent), then they will called directly after	946	before or after loading AnyEvent), then they will called directly after
…		…
1057		1113
1058	package AnyEvent;	1114	package AnyEvent;
1059		1115
1060	# basically a tuned-down version of common::sense	1116	# basically a tuned-down version of common::sense
1061	sub common_sense {	1117	sub common_sense {
1062	# no warnings	1118	# from common:.sense 1.0
1063	${^WARNING_BITS} ^= ${^WARNING_BITS};	1119	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1064	# use strict vars subs	1120	# use strict vars subs
1065	$^H \|= 0x00000600;	1121	$^H \|= 0x00000600;
1066	}	1122	}
1067		1123
1068	BEGIN { AnyEvent::common_sense }	1124	BEGIN { AnyEvent::common_sense }
1069		1125
1070	use Carp ();	1126	use Carp ();
1071		1127
1072	our $VERSION = 4.86;	1128	our $VERSION = '5.21';
1073	our $MODEL;	1129	our $MODEL;
1074		1130
1075	our $AUTOLOAD;	1131	our $AUTOLOAD;
1076	our @ISA;	1132	our @ISA;
1077		1133
1078	our @REGISTRY;	1134	our @REGISTRY;
1079
1080	our $WIN32;
1081		1135
1082	our $VERBOSE;	1136	our $VERBOSE;
1083		1137
1084	BEGIN {	1138	BEGIN {
1085	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1139	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
…		…
1102	for reverse split /\s,\s/,	1156	for reverse split /\s,\s/,
1103	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1157	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1104	}	1158	}
1105		1159
1106	my @models = (	1160	my @models = (
1107	[EV:: => AnyEvent::Impl::EV::],	1161	[EV:: => AnyEvent::Impl::EV:: , 1],
1108	[Event:: => AnyEvent::Impl::Event::],
1109	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1162	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1110	# everything below here will not be autoprobed	1163	# everything below here will not (normally) be autoprobed
1111	# as the pureperl backend should work everywhere	1164	# as the pureperl backend should work everywhere
1112	# and is usually faster	1165	# and is usually faster
		1166	[Event:: => AnyEvent::Impl::Event::, 1],
1113	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1167	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1114	[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
1115	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1170	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1116	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1171	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1117	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1172	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1118	[Wx:: => AnyEvent::Impl::POE::],	1173	[Wx:: => AnyEvent::Impl::POE::],
1119	[Prima:: => AnyEvent::Impl::POE::],	1174	[Prima:: => AnyEvent::Impl::POE::],
1120	# 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
1121	# byzantine signal and broken child handling, among others.	1176	# byzantine signal and broken child handling, among others.
1122	# 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
1123	# obvious default class.	1178	# obvious default class.
1124	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1179	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1180	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1126	# [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
1127	);	1183	);
1128		1184
1129	our %method = map +($_ => 1),	1185	our %method = map +($_ => 1),
1130	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);
1131		1187
…		…
1135	my ($cb) = @_;	1191	my ($cb) = @_;
1136		1192
1137	if ($MODEL) {	1193	if ($MODEL) {
1138	$cb->();	1194	$cb->();
1139		1195
1140	1	1196	undef
1141	} else {	1197	} else {
1142	push @post_detect, $cb;	1198	push @post_detect, $cb;
1143		1199
1144	defined wantarray	1200	defined wantarray
1145	? bless \$cb, "AnyEvent::Util::postdetect"	1201	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1177	}	1233	}
1178	}	1234	}
1179	}	1235	}
1180		1236
1181	unless ($MODEL) {	1237	unless ($MODEL) {
1182	# try to load a model	1238	# try to autoload a model
1183
1184	for (@REGISTRY, @models) {	1239	for (@REGISTRY, @models) {
1185	my ($package, $model) = @$_;	1240	my ($package, $model, $autoload) = @$_;
		1241	if (
		1242	$autoload
1186	if (eval "require $package"	1243	and eval "require $package"
1187	and ${"$package\::VERSION"} > 0	1244	and ${"$package\::VERSION"} > 0
1188	and eval "require $model") {	1245	and eval "require $model"
		1246	) {
1189	$MODEL = $model;	1247	$MODEL = $model;
1190	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1248	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1191	last;	1249	last;
1192	}	1250	}
1193	}	1251	}
1194		1252
1195	$MODEL	1253	$MODEL
…		…
1236	# 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
1237		1295
1238	($fh2, $rw)	1296	($fh2, $rw)
1239	}	1297	}
1240		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
1241	package AnyEvent::Base;	1349	package AnyEvent::Base;
1242		1350
1243	# default implementations for many methods	1351	# default implementations for many methods
1244		1352
1245	sub _time {	1353	sub _time() {
1246	# probe for availability of Time::HiRes	1354	# probe for availability of Time::HiRes
1247	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1355	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1248	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;
1249	*_time = \&Time::HiRes::time;	1357	*_time = \&Time::HiRes::time;
1250	# if (eval "use POSIX (); (POSIX::times())...	1358	# if (eval "use POSIX (); (POSIX::times())...
…		…
1267	}	1375	}
1268		1376
1269	# default implementation for ->signal	1377	# default implementation for ->signal
1270		1378
1271	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
1272	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1389	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1273	our (%SIG_ASY, %SIG_ASY_W);	1390	our (%SIG_ASY, %SIG_ASY_W);
1274	our ($SIG_COUNT, $SIG_TW);	1391	our ($SIG_COUNT, $SIG_TW);
1275		1392
1276	sub _signal_exec {	1393	sub _signal_exec {
1277	$HAVE_ASYNC_INTERRUPT	1394	$HAVE_ASYNC_INTERRUPT
1278	? $SIGPIPE_R->drain	1395	? $SIGPIPE_R->drain
1279	: sysread $SIGPIPE_R, my $dummy, 9;	1396	: sysread $SIGPIPE_R, (my $dummy), 9;
1280		1397
1281	while (%SIG_EV) {	1398	while (%SIG_EV) {
1282	for (keys %SIG_EV) {	1399	for (keys %SIG_EV) {
1283	delete $SIG_EV{$_};	1400	delete $SIG_EV{$_};
1284	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1401	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1285	}	1402	}
1286	}	1403	}
1287	}	1404	}
1288		1405
1289	# install a dumym wakeupw atcher to reduce signal catching latency	1406	# install a dummy wakeup watcher to reduce signal catching latency
1290	sub _sig_add() {	1407	sub _sig_add() {
1291	unless ($SIG_COUNT++) {	1408	unless ($SIG_COUNT++) {
1292	# try to align timer on a full-second boundary, if possible	1409	# try to align timer on a full-second boundary, if possible
1293	my $NOW = AnyEvent->now;	1410	my $NOW = AE::now;
1294		1411
1295	$SIG_TW = AnyEvent->timer (	1412	$SIG_TW = AE::timer
1296	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1413	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1297	interval => $MAX_SIGNAL_LATENCY,	1414	$MAX_SIGNAL_LATENCY,
1298	cb => sub { }, # just for the PERL_ASYNC_CHECK	1415	sub { } # just for the PERL_ASYNC_CHECK
1299	);	1416	;
1300	}	1417	}
1301	}	1418	}
1302		1419
1303	sub _sig_del {	1420	sub _sig_del {
1304	undef $SIG_TW	1421	undef $SIG_TW
1305	unless --$SIG_COUNT;	1422	unless --$SIG_COUNT;
1306	}	1423	}
1307		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
1308	sub _signal {	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 {
1309	my (undef, %arg) = @_;	1493	my (undef, %arg) = @_;
1310		1494
1311	my $signal = uc $arg{signal}	1495	my $signal = uc $arg{signal}
1312	or Carp::croak "required option 'signal' is missing";	1496	or Carp::croak "required option 'signal' is missing";
1313		1497
1314	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1315
1316	if ($HAVE_ASYNC_INTERRUPT) {	1498	if ($HAVE_ASYNC_INTERRUPT) {
1317	# async::interrupt	1499	# async::interrupt
1318		1500
1319	$SIG_ASY{$signal} \|\|= do {	1501	$signal = sig2num $signal;
1320	my $asy = new Async::Interrupt	1502	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1503
		1504	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1321	cb => sub { undef $SIG_EV{$signal} },	1505	cb => sub { undef $SIG_EV{$signal} },
1322	signal => $signal,	1506	signal => $signal,
1323	pipe => [$SIGPIPE_R->filenos],	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;
1324	;	1527	}
1325	$asy->pipe_autodrain (0);
1326		1528
1327	$asy	1529	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1328	};	1530	};
1329		1531
1330	} else {	1532	*AnyEvent::Base::signal::DESTROY = sub {
1331	# pure perl	1533	my ($signal, $cb) = @{$_[0]};
1332		1534
1333	$SIG{$signal} \|\|= sub {	1535	_sig_del;
1334	local $!;	1536
1335	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1537	delete $SIG_CB{$signal}{$cb};
		1538
		1539	$HAVE_ASYNC_INTERRUPT
		1540	? delete $SIG_ASY{$signal}
		1541	: # delete doesn't work with older perls - they then
		1542	# print weird messages, or just unconditionally exit
		1543	# instead of getting the default action.
1336	undef $SIG_EV{$signal};	1544	undef $SIG{$signal}
		1545	unless keys %{ $SIG_CB{$signal} };
1337	};	1546	};
1338
1339	# can't do signal processing without introducing races in pure perl,
1340	# so limit the signal latency.
1341	_sig_add;
1342	}	1547	};
1343		1548	die if $@;
1344	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1345	}
1346
1347	sub signal {
1348	# probe for availability of Async::Interrupt
1349	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1350	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1351
1352	$HAVE_ASYNC_INTERRUPT = 1;
1353	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1354	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1355
1356	} else {
1357	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1358
1359	require Fcntl;
1360
1361	if (AnyEvent::WIN32) {
1362	require AnyEvent::Util;
1363
1364	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1365	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1366	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1367	} else {
1368	pipe $SIGPIPE_R, $SIGPIPE_W;
1369	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1370	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1371
1372	# not strictly required, as $^F is normally 2, but let's make sure...
1373	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1375	}
1376
1377	$SIGPIPE_R
1378	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1379
1380	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1381	}
1382
1383	*signal = \&_signal;
1384	&signal	1549	&signal
1385	}
1386
1387	sub AnyEvent::Base::signal::DESTROY {
1388	my ($signal, $cb) = @{$_[0]};
1389
1390	_sig_del;
1391
1392	delete $SIG_CB{$signal}{$cb};
1393
1394	$HAVE_ASYNC_INTERRUPT
1395	? delete $SIG_ASY{$signal}
1396	: # delete doesn't work with older perls - they then
1397	# print weird messages, or just unconditionally exit
1398	# instead of getting the default action.
1399	undef $SIG{$signal}
1400	unless keys %{ $SIG_CB{$signal} };
1401	}	1550	}
1402		1551
1403	# default implementation for ->child	1552	# default implementation for ->child
1404		1553
1405	our %PID_CB;	1554	our %PID_CB;
1406	our $CHLD_W;	1555	our $CHLD_W;
1407	our $CHLD_DELAY_W;	1556	our $CHLD_DELAY_W;
1408	our $WNOHANG;	1557	our $WNOHANG;
1409		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
1410	sub _sigchld {	1567	sub _sigchld {
		1568	my $pid;
		1569
		1570	AnyEvent->_emit_childstatus ($pid, $?)
1411	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1571	while ($pid = waitpid -1, $WNOHANG) > 0;
1412	$_->($pid, $?)
1413	for values %{ $PID_CB{$pid} \|\| {} },
1414	values %{ $PID_CB{0} \|\| {} };
1415	}
1416	}	1572	}
1417		1573
1418	sub child {	1574	sub child {
1419	my (undef, %arg) = @_;	1575	my (undef, %arg) = @_;
1420		1576
…		…
1427	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1583	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1428	? 1	1584	? 1
1429	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1585	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1430		1586
1431	unless ($CHLD_W) {	1587	unless ($CHLD_W) {
1432	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1588	$CHLD_W = AE::signal CHLD => \&_sigchld;
1433	# 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
1434	&_sigchld;	1590	&_sigchld;
1435	}	1591	}
1436		1592
1437	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1593	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1463	# 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,
1464	# within some limits	1620	# within some limits
1465	$w = 0.0001 if $w < 0.0001;	1621	$w = 0.0001 if $w < 0.0001;
1466	$w = 5 if $w > 5;	1622	$w = 5 if $w > 5;
1467		1623
1468	$w = AnyEvent->timer (after => $w, cb => $rcb);	1624	$w = AE::timer $w, 0, $rcb;
1469	} else {	1625	} else {
1470	# clean up...	1626	# clean up...
1471	undef $w;	1627	undef $w;
1472	undef $rcb;	1628	undef $rcb;
1473	}	1629	}
1474	};	1630	};
1475		1631
1476	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1632	$w = AE::timer 0.05, 0, $rcb;
1477		1633
1478	bless \\$cb, "AnyEvent::Base::idle"	1634	bless \\$cb, "AnyEvent::Base::idle"
1479	}	1635	}
1480		1636
1481	sub AnyEvent::Base::idle::DESTROY {	1637	sub AnyEvent::Base::idle::DESTROY {
…		…
1535	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1691	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1536	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1692	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1537	}	1693	}
1538		1694
1539	sub cb {	1695	sub cb {
1540	$_[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
1541	$_[0]{_ae_cb}	1703	$cv->{_ae_cb}
1542	}	1704	}
1543		1705
1544	sub begin {	1706	sub begin {
1545	++$_[0]{_ae_counter};	1707	++$_[0]{_ae_counter};
1546	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1708	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1755	warn "read: $input\n"; # output what has been read	1917	warn "read: $input\n"; # output what has been read
1756	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1918	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1757	},	1919	},
1758	);	1920	);
1759		1921
1760	my $time_watcher; # can only be used once
1761
1762	sub new_timer {
1763	$timer = AnyEvent->timer (after => 1, cb => sub {	1922	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1764	warn "timeout\n"; # print 'timeout' about every second	1923	warn "timeout\n"; # print 'timeout' at most every second
1765	&new_timer; # and restart the time
1766	});	1924	});
1767	}
1768
1769	new_timer; # create first timer
1770		1925
1771	$cv->recv; # wait until user enters /^q/i	1926	$cv->recv; # wait until user enters /^q/i
1772		1927
1773	=head1 REAL-WORLD EXAMPLE	1928	=head1 REAL-WORLD EXAMPLE
1774		1929
…		…
1905	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
1906	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,
1907	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.
1908		2063
1909	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
1910	distribution.	2065	distribution. It uses the L<AE> interface, which makes a real difference
		2066	for the EV and Perl backends only.
1911		2067
1912	=head3 Explanation of the columns	2068	=head3 Explanation of the columns
1913		2069
1914	I<watcher> is the number of event watchers created/destroyed. Since	2070	I<watcher> is the number of event watchers created/destroyed. Since
1915	different event models feature vastly different performances, each event	2071	different event models feature vastly different performances, each event
…		…
1936	watcher.	2092	watcher.
1937		2093
1938	=head3 Results	2094	=head3 Results
1939		2095
1940	name watchers bytes create invoke destroy comment	2096	name watchers bytes create invoke destroy comment
1941	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
1942	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
1943	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
1944	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
1945	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
1946	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
1947	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
1948	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
1949	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
1950	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
1951	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
1952	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
1953		2109
1954	=head3 Discussion	2110	=head3 Discussion
1955		2111
1956	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
1957	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)
…		…
1969	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2125	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1970	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
1971	cycles with POE.	2127	cycles with POE.
1972		2128
1973	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
1974	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
1975	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).
1976	natively.
1977		2134
1978	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
1979	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
1980	interpreter and the backend itself). Nevertheless this shows that it	2137	interpreter and the backend itself). Nevertheless this shows that it
1981	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
…		…
2055	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
2056	(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
2057	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.
2058		2215
2059	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
2060	distribution.	2217	distribution. It uses the L<AE> interface, which makes a real difference
		2218	for the EV and Perl backends only.
2061		2219
2062	=head3 Explanation of the columns	2220	=head3 Explanation of the columns
2063		2221
2064	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
2065	each server has a read and write socket end).	2223	each server has a read and write socket end).
…		…
2073	a new one that moves the timeout into the future.	2231	a new one that moves the timeout into the future.
2074		2232
2075	=head3 Results	2233	=head3 Results
2076		2234
2077	name sockets create request	2235	name sockets create request
2078	EV 20000 69.01 11.16	2236	EV 20000 62.66 7.99
2079	Perl 20000 73.32 35.87	2237	Perl 20000 68.32 32.64
2080	IOAsync 20000 157.00 98.14 epoll	2238	IOAsync 20000 174.06 101.15 epoll
2081	IOAsync 20000 159.31 616.06 poll	2239	IOAsync 20000 174.67 610.84 poll
2082	Event 20000 212.62 257.32	2240	Event 20000 202.69 242.91
2083	Glib 20000 651.16 1896.30	2241	Glib 20000 557.01 1689.52
2084	POE 20000 349.67 12317.24 uses POE::Loop::Event	2242	POE 20000 341.54 12086.32 uses POE::Loop::Event
2085		2243
2086	=head3 Discussion	2244	=head3 Discussion
2087		2245
2088	This benchmark I<does> measure scalability and overall performance of the	2246	This benchmark I<does> measure scalability and overall performance of the
2089	particular event loop.	2247	particular event loop.
…		…
2215	As you can see, the AnyEvent + EV combination even beats the	2373	As you can see, the AnyEvent + EV combination even beats the
2216	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2374	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2217	backend easily beats IO::Lambda and POE.	2375	backend easily beats IO::Lambda and POE.
2218		2376
2219	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
2220	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
2221	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
2222	in a non-blocking way.	2380	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2223		2381
2224	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
2225	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
2226	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.
2227		2385
2228		2386
2229	=head1 SIGNALS	2387	=head1 SIGNALS
2230		2388
2231	AnyEvent currently installs handlers for these signals:	2389	AnyEvent currently installs handlers for these signals:
…		…
2320	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
2321	purely used for performance.	2479	purely used for performance.
2322		2480
2323	=item L<JSON> and L<JSON::XS>	2481	=item L<JSON> and L<JSON::XS>
2324		2482
2325	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
2326	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
2327	advantage of the ultra-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.
2328		2486
2329	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
2330	installed.	2488	installed.
2331		2489
…		…
2399	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2557	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2400		2558
2401	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2559	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2402	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>,
2403	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2561	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2404	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2562	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2405		2563
2406	Non-blocking file handles, sockets, TCP clients and	2564	Non-blocking file handles, sockets, TCP clients and
2407	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2565	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2408		2566
2409	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.251 by root, Mon Jul 20 22:39:57 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.251 by root, Mon Jul 20 22:39:57 2009 UTC vs.
Revision 1.297 by root, Thu Nov 19 01:55:57 2009 UTC