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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs.
Revision 1.295 by root, Wed Oct 28 02:42:06 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
…		…
355		369
356	=back	370	=back
357		371
358	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
359		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		375
360	You can watch for signals using a signal watcher, C<signal> is the signal	376	You can watch for signals using a signal watcher, C<signal> is the signal
361	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	377	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
363		379
364	Although the callback might get passed parameters, their value and	380	Although the callback might get passed parameters, their value and
…		…
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		400
385	=head3 Signal Races, Delays and Workarounds	401	=head3 Signal Races, Delays and Workarounds
386		402
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	403	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	404	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	405	do race-free signal handling in perl, requiring C libraries for
		406	this. AnyEvent will try to do it's best, which means in some cases,
390	in some cases, signals will be delayed. The maximum time a signal might	407	signals will be delayed. The maximum time a signal might be delayed is
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	409	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	410	and should be left alone otherwise. This variable determines how often
		411	AnyEvent polls for signals (in case a wake-up was missed). Higher values
394	will cause fewer spurious wake-ups, which is better for power and CPU	412	will cause fewer spurious wake-ups, which is better for power and CPU
		413	saving.
		414
395	saving. All these problems can be avoided by installing the optional	415	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	416	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>	417	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	418	(and not with L<POE> currently, as POE does it's own workaround with
399	those, you just have to suffer the delays.	419	one-second latency). For those, you just have to suffer the delays.
400		420
401	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
402		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
403	You can also watch on a child process exit and catch its exit status.	425	You can also watch on a child process exit and catch its exit status.
404		426
405	The child process is specified by the C<pid> argument (if set to C<0>, it	427	The child process is specified by the C<pid> argument (one some backends,
406	watches for any child process exit). The watcher will triggered only when	428	using C<0> watches for any child process exit, on others this will
407	the child process has finished and an exit status is available, not on	429	croak). The watcher will be triggered only when the child process has
408	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
409		432
410	The callback will be called with the pid and exit status (as returned by	433	The callback will be called with the pid and exit status (as returned by
411	waitpid), so unlike other watcher types, you I<can> rely on child watcher	434	waitpid), so unlike other watcher types, you I<can> rely on child watcher
412	callback arguments.	435	callback arguments.
413		436
…		…
454	# do something else, then wait for process exit	477	# do something else, then wait for process exit
455	$done->recv;	478	$done->recv;
456		479
457	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
458		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
459	Sometimes there is a need to do something, but it is not so important	484	Sometimes there is a need to do something, but it is not so important
460	to do it instantly, but only when there is nothing better to do. This	485	to do it instantly, but only when there is nothing better to do. This
461	"nothing better to do" is usually defined to be "no other events need	486	"nothing better to do" is usually defined to be "no other events need
462	attention by the event loop".	487	attention by the event loop".
463		488
…		…
489	});	514	});
490	});	515	});
491		516
492	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
493		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
494	If you are familiar with some event loops you will know that all of them	524	If you are familiar with some event loops you will know that all of them
495	require you to run some blocking "loop", "run" or similar function that	525	require you to run some blocking "loop", "run" or similar function that
496	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
497		527
498	AnyEvent is slightly different: it expects somebody else to run the event	528	AnyEvent is slightly different: it expects somebody else to run the event
…		…
517	Condition variables are similar to callbacks, except that you can	547	Condition variables are similar to callbacks, except that you can
518	optionally wait for them. They can also be called merge points - points	548	optionally wait for them. They can also be called merge points - points
519	in time where multiple outstanding events have been processed. And yet	549	in time where multiple outstanding events have been processed. And yet
520	another way to call them is transactions - each condition variable can be	550	another way to call them is transactions - each condition variable can be
521	used to represent a transaction, which finishes at some point and delivers	551	used to represent a transaction, which finishes at some point and delivers
522	a result.	552	a result. And yet some people know them as "futures" - a promise to
		553	compute/deliver something that you can wait for.
523		554
524	Condition variables are very useful to signal that something has finished,	555	Condition variables are very useful to signal that something has finished,
525	for example, if you write a module that does asynchronous http requests,	556	for example, if you write a module that does asynchronous http requests,
526	then a condition variable would be the ideal candidate to signal the	557	then a condition variable would be the ideal candidate to signal the
527	availability of results. The user can either act when the callback is	558	availability of results. The user can either act when the callback is
…		…
561	after => 1,	592	after => 1,
562	cb => sub { $result_ready->send },	593	cb => sub { $result_ready->send },
563	);	594	);
564		595
565	# this "blocks" (while handling events) till the callback	596	# this "blocks" (while handling events) till the callback
566	# calls -<send	597	# calls ->send
567	$result_ready->recv;	598	$result_ready->recv;
568		599
569	Example: wait for a timer, but take advantage of the fact that condition	600	Example: wait for a timer, but take advantage of the fact that condition
570	variables are also callable directly.	601	variables are also callable directly.
571		602
…		…
635	one. For example, a function that pings many hosts in parallel might want	666	one. For example, a function that pings many hosts in parallel might want
636	to use a condition variable for the whole process.	667	to use a condition variable for the whole process.
637		668
638	Every call to C<< ->begin >> will increment a counter, and every call to	669	Every call to C<< ->begin >> will increment a counter, and every call to
639	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
640	>>, the (last) callback passed to C<begin> will be executed. That callback	671	>>, the (last) callback passed to C<begin> will be executed, passing the
641	is I<supposed> to call C<< ->send >>, but that is not required. If no	672	condvar as first argument. That callback is I<supposed> to call C<< ->send
642	callback was set, C<send> will be called without any arguments.	673	>>, but that is not required. If no group callback was set, C<send> will
		674	be called without any arguments.
643		675
644	You can think of C<< $cv->send >> giving you an OR condition (one call	676	You can think of C<< $cv->send >> giving you an OR condition (one call
645	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	677	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
646	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	678	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
647		679
…		…
674	begung can potentially be zero:	706	begung can potentially be zero:
675		707
676	my $cv = AnyEvent->condvar;	708	my $cv = AnyEvent->condvar;
677		709
678	my %result;	710	my %result;
679	$cv->begin (sub { $cv->send (\%result) });	711	$cv->begin (sub { shift->send (\%result) });
680		712
681	for my $host (@list_of_hosts) {	713	for my $host (@list_of_hosts) {
682	$cv->begin;	714	$cv->begin;
683	ping_host_then_call_callback $host, sub {	715	ping_host_then_call_callback $host, sub {
684	$result{$host} = ...;	716	$result{$host} = ...;
…		…
759	=item $cb = $cv->cb ($cb->($cv))	791	=item $cb = $cv->cb ($cb->($cv))
760		792
761	This is a mutator function that returns the callback set and optionally	793	This is a mutator function that returns the callback set and optionally
762	replaces it before doing so.	794	replaces it before doing so.
763		795
764	The callback will be called when the condition becomes "true", i.e. when	796	The callback will be called when the condition becomes (or already was)
765	C<send> or C<croak> are called, with the only argument being the condition	797	"true", i.e. when C<send> or C<croak> are called (or were called), with
766	variable itself. Calling C<recv> inside the callback or at any later time	798	the only argument being the condition variable itself. Calling C<recv>
767	is guaranteed not to block.	799	inside the callback or at any later time is guaranteed not to block.
768		800
769	=back	801	=back
770		802
771	=head1 SUPPORTED EVENT LOOPS/BACKENDS	803	=head1 SUPPORTED EVENT LOOPS/BACKENDS
772		804
…		…
775	=over 4	807	=over 4
776		808
777	=item Backends that are autoprobed when no other event loop can be found.	809	=item Backends that are autoprobed when no other event loop can be found.
778		810
779	EV is the preferred backend when no other event loop seems to be in	811	EV is the preferred backend when no other event loop seems to be in
780	use. If EV is not installed, then AnyEvent will try Event, and, failing	812	use. If EV is not installed, then AnyEvent will fall back to its own
781	that, will fall back to its own pure-perl implementation, which is	813	pure-perl implementation, which is available everywhere as it comes with
782	available everywhere as it comes with AnyEvent itself.	814	AnyEvent itself.
783		815
784	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	816	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
785	AnyEvent::Impl::Event based on Event, very stable, few glitches.
786	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
787		818
788	=item Backends that are transparently being picked up when they are used.	819	=item Backends that are transparently being picked up when they are used.
789		820
790	These will be used when they are currently loaded when the first watcher	821	These will be used when they are currently loaded when the first watcher
791	is created, in which case it is assumed that the application is using	822	is created, in which case it is assumed that the application is using
792	them. This means that AnyEvent will automatically pick the right backend	823	them. This means that AnyEvent will automatically pick the right backend
793	when the main program loads an event module before anything starts to	824	when the main program loads an event module before anything starts to
794	create watchers. Nothing special needs to be done by the main program.	825	create watchers. Nothing special needs to be done by the main program.
795		826
		827	AnyEvent::Impl::Event based on Event, very stable, few glitches.
796	AnyEvent::Impl::Glib based on Glib, slow but very stable.	828	AnyEvent::Impl::Glib based on Glib, slow but very stable.
797	AnyEvent::Impl::Tk based on Tk, very broken.	829	AnyEvent::Impl::Tk based on Tk, very broken.
798	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	830	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
799	AnyEvent::Impl::POE based on POE, very slow, some limitations.	831	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		832	AnyEvent::Impl::Irssi used when running within irssi.
800		833
801	=item Backends with special needs.	834	=item Backends with special needs.
802		835
803	Qt requires the Qt::Application to be instantiated first, but will	836	Qt requires the Qt::Application to be instantiated first, but will
804	otherwise be picked up automatically. As long as the main program	837	otherwise be picked up automatically. As long as the main program
…		…
878	event module detection too early, for example, L<AnyEvent::AIO> creates	911	event module detection too early, for example, L<AnyEvent::AIO> creates
879	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	912	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
880	avoid autodetecting the event module at load time.	913	avoid autodetecting the event module at load time.
881		914
882	If called in scalar or list context, then it creates and returns an object	915	If called in scalar or list context, then it creates and returns an object
883	that automatically removes the callback again when it is destroyed. See	916	that automatically removes the callback again when it is destroyed (or
		917	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
884	L<Coro::BDB> for a case where this is useful.	918	a case where this is useful.
		919
		920	Example: Create a watcher for the IO::AIO module and store it in
		921	C<$WATCHER>. Only do so after the event loop is initialised, though.
		922
		923	our WATCHER;
		924
		925	my $guard = AnyEvent::post_detect {
		926	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		927	};
		928
		929	# the \|\|= is important in case post_detect immediately runs the block,
		930	# as to not clobber the newly-created watcher. assigning both watcher and
		931	# post_detect guard to the same variable has the advantage of users being
		932	# able to just C<undef $WATCHER> if the watcher causes them grief.
		933
		934	$WATCHER \|\|= $guard;
885		935
886	=item @AnyEvent::post_detect	936	=item @AnyEvent::post_detect
887		937
888	If there are any code references in this array (you can C<push> to it	938	If there are any code references in this array (you can C<push> to it
889	before or after loading AnyEvent), then they will called directly after	939	before or after loading AnyEvent), then they will called directly after
…		…
1056		1106
1057	package AnyEvent;	1107	package AnyEvent;
1058		1108
1059	# basically a tuned-down version of common::sense	1109	# basically a tuned-down version of common::sense
1060	sub common_sense {	1110	sub common_sense {
1061	# no warnings	1111	# from common:.sense 1.0
1062	${^WARNING_BITS} ^= ${^WARNING_BITS};	1112	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1063	# use strict vars subs	1113	# use strict vars subs
1064	$^H \|= 0x00000600;	1114	$^H \|= 0x00000600;
1065	}	1115	}
1066		1116
1067	BEGIN { AnyEvent::common_sense }	1117	BEGIN { AnyEvent::common_sense }
1068		1118
1069	use Carp ();	1119	use Carp ();
1070		1120
1071	our $VERSION = 4.85;	1121	our $VERSION = '5.202';
1072	our $MODEL;	1122	our $MODEL;
1073		1123
1074	our $AUTOLOAD;	1124	our $AUTOLOAD;
1075	our @ISA;	1125	our @ISA;
1076		1126
…		…
1101	for reverse split /\s,\s/,	1151	for reverse split /\s,\s/,
1102	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1152	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1103	}	1153	}
1104		1154
1105	my @models = (	1155	my @models = (
1106	[EV:: => AnyEvent::Impl::EV::],	1156	[EV:: => AnyEvent::Impl::EV:: , 1],
1107	[Event:: => AnyEvent::Impl::Event::],
1108	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1109	# everything below here will not be autoprobed	1158	# everything below here will not (normally) be autoprobed
1110	# as the pureperl backend should work everywhere	1159	# as the pureperl backend should work everywhere
1111	# and is usually faster	1160	# and is usually faster
		1161	[Event:: => AnyEvent::Impl::Event::, 1],
1112	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1162	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1113	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1163	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1164	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1114	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1165	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1115	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1166	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1116	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1167	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1117	[Wx:: => AnyEvent::Impl::POE::],	1168	[Wx:: => AnyEvent::Impl::POE::],
1118	[Prima:: => AnyEvent::Impl::POE::],	1169	[Prima:: => AnyEvent::Impl::POE::],
1119	# IO::Async is just too broken - we would need workarounds for its	1170	# IO::Async is just too broken - we would need workarounds for its
1120	# byzantine signal and broken child handling, among others.	1171	# byzantine signal and broken child handling, among others.
1121	# IO::Async is rather hard to detect, as it doesn't have any	1172	# IO::Async is rather hard to detect, as it doesn't have any
1122	# obvious default class.	1173	# obvious default class.
1123	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1124	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1176	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1177	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1126	);	1178	);
1127		1179
1128	our %method = map +($_ => 1),	1180	our %method = map +($_ => 1),
1129	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1181	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1130		1182
…		…
1134	my ($cb) = @_;	1186	my ($cb) = @_;
1135		1187
1136	if ($MODEL) {	1188	if ($MODEL) {
1137	$cb->();	1189	$cb->();
1138		1190
1139	1	1191	undef
1140	} else {	1192	} else {
1141	push @post_detect, $cb;	1193	push @post_detect, $cb;
1142		1194
1143	defined wantarray	1195	defined wantarray
1144	? bless \$cb, "AnyEvent::Util::postdetect"	1196	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1176	}	1228	}
1177	}	1229	}
1178	}	1230	}
1179		1231
1180	unless ($MODEL) {	1232	unless ($MODEL) {
1181	# try to load a model	1233	# try to autoload a model
1182
1183	for (@REGISTRY, @models) {	1234	for (@REGISTRY, @models) {
1184	my ($package, $model) = @$_;	1235	my ($package, $model, $autoload) = @$_;
		1236	if (
		1237	$autoload
1185	if (eval "require $package"	1238	and eval "require $package"
1186	and ${"$package\::VERSION"} > 0	1239	and ${"$package\::VERSION"} > 0
1187	and eval "require $model") {	1240	and eval "require $model"
		1241	) {
1188	$MODEL = $model;	1242	$MODEL = $model;
1189	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1243	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1190	last;	1244	last;
1191	}	1245	}
1192	}	1246	}
1193		1247
1194	$MODEL	1248	$MODEL
…		…
1235	# we assume CLOEXEC is already set by perl in all important cases	1289	# we assume CLOEXEC is already set by perl in all important cases
1236		1290
1237	($fh2, $rw)	1291	($fh2, $rw)
1238	}	1292	}
1239		1293
		1294	=head1 SIMPLIFIED AE API
		1295
		1296	Starting with version 5.0, AnyEvent officially supports a second, much
		1297	simpler, API that is designed to reduce the calling, typing and memory
		1298	overhead.
		1299
		1300	See the L<AE> manpage for details.
		1301
		1302	=cut
		1303
		1304	package AE;
		1305
		1306	our $VERSION = $AnyEvent::VERSION;
		1307
		1308	sub io($$$) {
		1309	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1310	}
		1311
		1312	sub timer($$$) {
		1313	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1314	}
		1315
		1316	sub signal($$) {
		1317	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1318	}
		1319
		1320	sub child($$) {
		1321	AnyEvent->child (pid => $_[0], cb => $_[1])
		1322	}
		1323
		1324	sub idle($) {
		1325	AnyEvent->idle (cb => $_[0])
		1326	}
		1327
		1328	sub cv(;&) {
		1329	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1330	}
		1331
		1332	sub now() {
		1333	AnyEvent->now
		1334	}
		1335
		1336	sub now_update() {
		1337	AnyEvent->now_update
		1338	}
		1339
		1340	sub time() {
		1341	AnyEvent->time
		1342	}
		1343
1240	package AnyEvent::Base;	1344	package AnyEvent::Base;
1241		1345
1242	# default implementations for many methods	1346	# default implementations for many methods
1243		1347
1244	sub _time {	1348	sub _time() {
1245	# probe for availability of Time::HiRes	1349	# probe for availability of Time::HiRes
1246	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1350	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1247	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1351	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1248	*_time = \&Time::HiRes::time;	1352	*_time = \&Time::HiRes::time;
1249	# if (eval "use POSIX (); (POSIX::times())...	1353	# if (eval "use POSIX (); (POSIX::times())...
…		…
1266	}	1370	}
1267		1371
1268	# default implementation for ->signal	1372	# default implementation for ->signal
1269		1373
1270	our $HAVE_ASYNC_INTERRUPT;	1374	our $HAVE_ASYNC_INTERRUPT;
		1375
		1376	sub _have_async_interrupt() {
		1377	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1378	&& eval "use Async::Interrupt 1.02 (); 1")
		1379	unless defined $HAVE_ASYNC_INTERRUPT;
		1380
		1381	$HAVE_ASYNC_INTERRUPT
		1382	}
		1383
1271	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1384	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1272	our (%SIG_ASY, %SIG_ASY_W);	1385	our (%SIG_ASY, %SIG_ASY_W);
1273	our ($SIG_COUNT, $SIG_TW);	1386	our ($SIG_COUNT, $SIG_TW);
1274		1387
1275	sub _signal_exec {	1388	sub _signal_exec {
1276	$HAVE_ASYNC_INTERRUPT	1389	$HAVE_ASYNC_INTERRUPT
1277	? $SIGPIPE_R->drain	1390	? $SIGPIPE_R->drain
1278	: sysread $SIGPIPE_R, my $dummy, 9;	1391	: sysread $SIGPIPE_R, (my $dummy), 9;
1279		1392
1280	while (%SIG_EV) {	1393	while (%SIG_EV) {
1281	for (keys %SIG_EV) {	1394	for (keys %SIG_EV) {
1282	delete $SIG_EV{$_};	1395	delete $SIG_EV{$_};
1283	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1396	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1284	}	1397	}
1285	}	1398	}
1286	}	1399	}
1287		1400
1288	# install a dumym wakeupw atcher to reduce signal catching latency	1401	# install a dummy wakeup watcher to reduce signal catching latency
1289	sub _sig_add() {	1402	sub _sig_add() {
1290	unless ($SIG_COUNT++) {	1403	unless ($SIG_COUNT++) {
1291	# try to align timer on a full-second boundary, if possible	1404	# try to align timer on a full-second boundary, if possible
1292	my $NOW = AnyEvent->now;	1405	my $NOW = AE::now;
1293		1406
1294	$SIG_TW = AnyEvent->timer (	1407	$SIG_TW = AE::timer
1295	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1408	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1296	interval => $MAX_SIGNAL_LATENCY,	1409	$MAX_SIGNAL_LATENCY,
1297	cb => sub { }, # just for the PERL_ASYNC_CHECK	1410	sub { } # just for the PERL_ASYNC_CHECK
1298	);	1411	;
1299	}	1412	}
1300	}	1413	}
1301		1414
1302	sub _sig_del {	1415	sub _sig_del {
1303	undef $SIG_TW	1416	undef $SIG_TW
1304	unless --$SIG_COUNT;	1417	unless --$SIG_COUNT;
1305	}	1418	}
1306		1419
		1420	our $_sig_name_init; $_sig_name_init = sub {
		1421	eval q{ # poor man's autoloading
		1422	undef $_sig_name_init;
		1423
		1424	if (_have_async_interrupt) {
		1425	*sig2num = \&Async::Interrupt::sig2num;
		1426	*sig2name = \&Async::Interrupt::sig2name;
		1427	} else {
		1428	require Config;
		1429
		1430	my %signame2num;
		1431	@signame2num{ split ' ', $Config::Config{sig_name} }
		1432	= split ' ', $Config::Config{sig_num};
		1433
		1434	my @signum2name;
		1435	@signum2name[values %signame2num] = keys %signame2num;
		1436
		1437	*sig2num = sub($) {
		1438	$_[0] > 0 ? shift : $signame2num{+shift}
		1439	};
		1440	*sig2name = sub ($) {
		1441	$_[0] > 0 ? $signum2name[+shift] : shift
		1442	};
		1443	}
		1444	};
		1445	die if $@;
		1446	};
		1447
		1448	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1449	sub sig2name($) { &$_sig_name_init; &sig2name }
		1450
1307	sub _signal {	1451	sub signal {
		1452	eval q{ # poor man's autoloading {}
		1453	# probe for availability of Async::Interrupt
		1454	if (_have_async_interrupt) {
		1455	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1456
		1457	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1458	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1459
		1460	} else {
		1461	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1462
		1463	require Fcntl;
		1464
		1465	if (AnyEvent::WIN32) {
		1466	require AnyEvent::Util;
		1467
		1468	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1470	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1471	} else {
		1472	pipe $SIGPIPE_R, $SIGPIPE_W;
		1473	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1474	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1475
		1476	# not strictly required, as $^F is normally 2, but let's make sure...
		1477	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1478	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1479	}
		1480
		1481	$SIGPIPE_R
		1482	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1483
		1484	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1485	}
		1486
		1487	*signal = sub {
1308	my (undef, %arg) = @_;	1488	my (undef, %arg) = @_;
1309		1489
1310	my $signal = uc $arg{signal}	1490	my $signal = uc $arg{signal}
1311	or Carp::croak "required option 'signal' is missing";	1491	or Carp::croak "required option 'signal' is missing";
1312		1492
1313	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1314
1315	if ($HAVE_ASYNC_INTERRUPT) {	1493	if ($HAVE_ASYNC_INTERRUPT) {
1316	# async::interrupt	1494	# async::interrupt
1317		1495
1318	$SIG_ASY{$signal} \|\|= do {	1496	$signal = sig2num $signal;
1319	my $asy = new Async::Interrupt	1497	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1498
		1499	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1320	cb => sub { undef $SIG_EV{$signal} },	1500	cb => sub { undef $SIG_EV{$signal} },
1321	signal => $signal,	1501	signal => $signal,
1322	pipe => [$SIGPIPE_R->filenos],	1502	pipe => [$SIGPIPE_R->filenos],
		1503	pipe_autodrain => 0,
		1504	;
		1505
		1506	} else {
		1507	# pure perl
		1508
		1509	# AE::Util has been loaded in signal
		1510	$signal = sig2name $signal;
		1511	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1512
		1513	$SIG{$signal} \|\|= sub {
		1514	local $!;
		1515	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1516	undef $SIG_EV{$signal};
		1517	};
		1518
		1519	# can't do signal processing without introducing races in pure perl,
		1520	# so limit the signal latency.
		1521	_sig_add;
1323	;	1522	}
1324	$asy->pipe_autodrain (0);
1325		1523
1326	$asy	1524	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1327	};	1525	};
1328		1526
1329	} else {	1527	*AnyEvent::Base::signal::DESTROY = sub {
1330	# pure perl	1528	my ($signal, $cb) = @{$_[0]};
1331		1529
1332	$SIG{$signal} \|\|= sub {	1530	_sig_del;
1333	local $!;	1531
1334	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1532	delete $SIG_CB{$signal}{$cb};
		1533
		1534	$HAVE_ASYNC_INTERRUPT
		1535	? delete $SIG_ASY{$signal}
		1536	: # delete doesn't work with older perls - they then
		1537	# print weird messages, or just unconditionally exit
		1538	# instead of getting the default action.
1335	undef $SIG_EV{$signal};	1539	undef $SIG{$signal}
		1540	unless keys %{ $SIG_CB{$signal} };
1336	};	1541	};
1337
1338	# can't do signal processing without introducing races in pure perl,
1339	# so limit the signal latency.
1340	_sig_add;
1341	}	1542	};
1342		1543	die if $@;
1343	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1344	}
1345
1346	sub signal {
1347	# probe for availability of Async::Interrupt
1348	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1349	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1350
1351	$HAVE_ASYNC_INTERRUPT = 1;
1352	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1353	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1354
1355	} else {
1356	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1357
1358	require Fcntl;
1359
1360	if (AnyEvent::WIN32) {
1361	require AnyEvent::Util;
1362
1363	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1364	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1365	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1366	} else {
1367	pipe $SIGPIPE_R, $SIGPIPE_W;
1368	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1369	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1370
1371	# not strictly required, as $^F is normally 2, but let's make sure...
1372	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1373	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374	}
1375
1376	$SIGPIPE_R
1377	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1378
1379	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1380	}
1381
1382	*signal = \&_signal;
1383	&signal	1544	&signal
1384	}
1385
1386	sub AnyEvent::Base::signal::DESTROY {
1387	my ($signal, $cb) = @{$_[0]};
1388
1389	_sig_del;
1390
1391	delete $SIG_CB{$signal}{$cb};
1392
1393	$HAVE_ASYNC_INTERRUPT
1394	? delete $SIG_ASY{$signal}
1395	: # delete doesn't work with older perls - they then
1396	# print weird messages, or just unconditionally exit
1397	# instead of getting the default action.
1398	undef $SIG{$signal}
1399	unless keys %{ $SIG_CB{$signal} };
1400	}	1545	}
1401		1546
1402	# default implementation for ->child	1547	# default implementation for ->child
1403		1548
1404	our %PID_CB;	1549	our %PID_CB;
1405	our $CHLD_W;	1550	our $CHLD_W;
1406	our $CHLD_DELAY_W;	1551	our $CHLD_DELAY_W;
1407	our $WNOHANG;	1552	our $WNOHANG;
1408		1553
		1554	sub _emit_childstatus($$) {
		1555	my (undef, $rpid, $rstatus) = @_;
		1556
		1557	$_->($rpid, $rstatus)
		1558	for values %{ $PID_CB{$rpid} \|\| {} },
		1559	values %{ $PID_CB{0} \|\| {} };
		1560	}
		1561
1409	sub _sigchld {	1562	sub _sigchld {
		1563	my $pid;
		1564
		1565	AnyEvent->_emit_childstatus ($pid, $?)
1410	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1566	while ($pid = waitpid -1, $WNOHANG) > 0;
1411	$_->($pid, $?)
1412	for values %{ $PID_CB{$pid} \|\| {} },
1413	values %{ $PID_CB{0} \|\| {} };
1414	}
1415	}	1567	}
1416		1568
1417	sub child {	1569	sub child {
1418	my (undef, %arg) = @_;	1570	my (undef, %arg) = @_;
1419		1571
…		…
1426	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1578	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1427	? 1	1579	? 1
1428	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1580	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1429		1581
1430	unless ($CHLD_W) {	1582	unless ($CHLD_W) {
1431	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1583	$CHLD_W = AE::signal CHLD => \&_sigchld;
1432	# child could be a zombie already, so make at least one round	1584	# child could be a zombie already, so make at least one round
1433	&_sigchld;	1585	&_sigchld;
1434	}	1586	}
1435		1587
1436	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1588	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1462	# never use more then 50% of the time for the idle watcher,	1614	# never use more then 50% of the time for the idle watcher,
1463	# within some limits	1615	# within some limits
1464	$w = 0.0001 if $w < 0.0001;	1616	$w = 0.0001 if $w < 0.0001;
1465	$w = 5 if $w > 5;	1617	$w = 5 if $w > 5;
1466		1618
1467	$w = AnyEvent->timer (after => $w, cb => $rcb);	1619	$w = AE::timer $w, 0, $rcb;
1468	} else {	1620	} else {
1469	# clean up...	1621	# clean up...
1470	undef $w;	1622	undef $w;
1471	undef $rcb;	1623	undef $rcb;
1472	}	1624	}
1473	};	1625	};
1474		1626
1475	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1627	$w = AE::timer 0.05, 0, $rcb;
1476		1628
1477	bless \\$cb, "AnyEvent::Base::idle"	1629	bless \\$cb, "AnyEvent::Base::idle"
1478	}	1630	}
1479		1631
1480	sub AnyEvent::Base::idle::DESTROY {	1632	sub AnyEvent::Base::idle::DESTROY {
…		…
1534	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1686	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1535	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1687	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1536	}	1688	}
1537		1689
1538	sub cb {	1690	sub cb {
1539	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1691	my $cv = shift;
		1692
		1693	@_
		1694	and $cv->{_ae_cb} = shift
		1695	and $cv->{_ae_sent}
		1696	and (delete $cv->{_ae_cb})->($cv);
		1697
1540	$_[0]{_ae_cb}	1698	$cv->{_ae_cb}
1541	}	1699	}
1542		1700
1543	sub begin {	1701	sub begin {
1544	++$_[0]{_ae_counter};	1702	++$_[0]{_ae_counter};
1545	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1703	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1754	warn "read: $input\n"; # output what has been read	1912	warn "read: $input\n"; # output what has been read
1755	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1913	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1756	},	1914	},
1757	);	1915	);
1758		1916
1759	my $time_watcher; # can only be used once
1760
1761	sub new_timer {
1762	$timer = AnyEvent->timer (after => 1, cb => sub {	1917	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1763	warn "timeout\n"; # print 'timeout' about every second	1918	warn "timeout\n"; # print 'timeout' at most every second
1764	&new_timer; # and restart the time
1765	});	1919	});
1766	}
1767
1768	new_timer; # create first timer
1769		1920
1770	$cv->recv; # wait until user enters /^q/i	1921	$cv->recv; # wait until user enters /^q/i
1771		1922
1772	=head1 REAL-WORLD EXAMPLE	1923	=head1 REAL-WORLD EXAMPLE
1773		1924
…		…
1904	through AnyEvent. The benchmark creates a lot of timers (with a zero	2055	through AnyEvent. The benchmark creates a lot of timers (with a zero
1905	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2056	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1906	which it is), lets them fire exactly once and destroys them again.	2057	which it is), lets them fire exactly once and destroys them again.
1907		2058
1908	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2059	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1909	distribution.	2060	distribution. It uses the L<AE> interface, which makes a real difference
		2061	for the EV and Perl backends only.
1910		2062
1911	=head3 Explanation of the columns	2063	=head3 Explanation of the columns
1912		2064
1913	I<watcher> is the number of event watchers created/destroyed. Since	2065	I<watcher> is the number of event watchers created/destroyed. Since
1914	different event models feature vastly different performances, each event	2066	different event models feature vastly different performances, each event
…		…
1935	watcher.	2087	watcher.
1936		2088
1937	=head3 Results	2089	=head3 Results
1938		2090
1939	name watchers bytes create invoke destroy comment	2091	name watchers bytes create invoke destroy comment
1940	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2092	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1941	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2093	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1942	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2094	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1943	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2095	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1944	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2096	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1945	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2097	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1946	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2098	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1947	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2099	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1948	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2100	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1949	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2101	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1950	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2102	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1951	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2103	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1952		2104
1953	=head3 Discussion	2105	=head3 Discussion
1954		2106
1955	The benchmark does I<not> measure scalability of the event loop very	2107	The benchmark does I<not> measure scalability of the event loop very
1956	well. For example, a select-based event loop (such as the pure perl one)	2108	well. For example, a select-based event loop (such as the pure perl one)
…		…
1968	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2120	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1969	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2121	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1970	cycles with POE.	2122	cycles with POE.
1971		2123
1972	C<EV> is the sole leader regarding speed and memory use, which are both	2124	C<EV> is the sole leader regarding speed and memory use, which are both
1973	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2125	maximal/minimal, respectively. When using the L<AE> API there is zero
		2126	overhead (when going through the AnyEvent API create is about 5-6 times
		2127	slower, with other times being equal, so still uses far less memory than
1974	far less memory than any other event loop and is still faster than Event	2128	any other event loop and is still faster than Event natively).
1975	natively.
1976		2129
1977	The pure perl implementation is hit in a few sweet spots (both the	2130	The pure perl implementation is hit in a few sweet spots (both the
1978	constant timeout and the use of a single fd hit optimisations in the perl	2131	constant timeout and the use of a single fd hit optimisations in the perl
1979	interpreter and the backend itself). Nevertheless this shows that it	2132	interpreter and the backend itself). Nevertheless this shows that it
1980	adds very little overhead in itself. Like any select-based backend its	2133	adds very little overhead in itself. Like any select-based backend its
…		…
2054	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2207	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2055	(1%) are active. This mirrors the activity of large servers with many	2208	(1%) are active. This mirrors the activity of large servers with many
2056	connections, most of which are idle at any one point in time.	2209	connections, most of which are idle at any one point in time.
2057		2210
2058	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2211	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2059	distribution.	2212	distribution. It uses the L<AE> interface, which makes a real difference
		2213	for the EV and Perl backends only.
2060		2214
2061	=head3 Explanation of the columns	2215	=head3 Explanation of the columns
2062		2216
2063	I<sockets> is the number of sockets, and twice the number of "servers" (as	2217	I<sockets> is the number of sockets, and twice the number of "servers" (as
2064	each server has a read and write socket end).	2218	each server has a read and write socket end).
…		…
2072	a new one that moves the timeout into the future.	2226	a new one that moves the timeout into the future.
2073		2227
2074	=head3 Results	2228	=head3 Results
2075		2229
2076	name sockets create request	2230	name sockets create request
2077	EV 20000 69.01 11.16	2231	EV 20000 62.66 7.99
2078	Perl 20000 73.32 35.87	2232	Perl 20000 68.32 32.64
2079	IOAsync 20000 157.00 98.14 epoll	2233	IOAsync 20000 174.06 101.15 epoll
2080	IOAsync 20000 159.31 616.06 poll	2234	IOAsync 20000 174.67 610.84 poll
2081	Event 20000 212.62 257.32	2235	Event 20000 202.69 242.91
2082	Glib 20000 651.16 1896.30	2236	Glib 20000 557.01 1689.52
2083	POE 20000 349.67 12317.24 uses POE::Loop::Event	2237	POE 20000 341.54 12086.32 uses POE::Loop::Event
2084		2238
2085	=head3 Discussion	2239	=head3 Discussion
2086		2240
2087	This benchmark I<does> measure scalability and overall performance of the	2241	This benchmark I<does> measure scalability and overall performance of the
2088	particular event loop.	2242	particular event loop.
…		…
2214	As you can see, the AnyEvent + EV combination even beats the	2368	As you can see, the AnyEvent + EV combination even beats the
2215	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2369	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2216	backend easily beats IO::Lambda and POE.	2370	backend easily beats IO::Lambda and POE.
2217		2371
2218	And even the 100% non-blocking version written using the high-level (and	2372	And even the 100% non-blocking version written using the high-level (and
2219	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2373	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2220	large margin, even though it does all of DNS, tcp-connect and socket I/O	2374	higher level ("unoptimised") abstractions by a large margin, even though
2221	in a non-blocking way.	2375	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2222		2376
2223	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2377	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2224	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2378	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2225	part of the IO::lambda distribution and were used without any changes.	2379	part of the IO::Lambda distribution and were used without any changes.
2226		2380
2227		2381
2228	=head1 SIGNALS	2382	=head1 SIGNALS
2229		2383
2230	AnyEvent currently installs handlers for these signals:	2384	AnyEvent currently installs handlers for these signals:
…		…
2319	lot less memory), but otherwise doesn't affect guard operation much. It is	2473	lot less memory), but otherwise doesn't affect guard operation much. It is
2320	purely used for performance.	2474	purely used for performance.
2321		2475
2322	=item L<JSON> and L<JSON::XS>	2476	=item L<JSON> and L<JSON::XS>
2323		2477
2324	This module is required when you want to read or write JSON data via	2478	One of these modules is required when you want to read or write JSON data
2325	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2479	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2326	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2480	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2327		2481
2328	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2482	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2329	installed.	2483	installed.
2330		2484
…		…
2398	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2552	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2399		2553
2400	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2554	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2401	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2555	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2402	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2556	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2403	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2557	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2404		2558
2405	Non-blocking file handles, sockets, TCP clients and	2559	Non-blocking file handles, sockets, TCP clients and
2406	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2560	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2407		2561
2408	Asynchronous DNS: L<AnyEvent::DNS>.	2562	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs. Revision 1.295 by root, Wed Oct 28 02:42:06 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs.
Revision 1.295 by root, Wed Oct 28 02:42:06 2009 UTC