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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.263 by root, Wed Jul 29 12:39:21 2009 UTC vs.
Revision 1.311 by root, Wed Feb 10 13:33:44 2010 UTC

…		…
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
…		…
380		403
381	Example: exit on SIGINT	404	Example: exit on SIGINT
382		405
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		407
		408	=head3 Restart Behaviour
		409
		410	While restart behaviour is up to the event loop implementation, most will
		411	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		412	pure perl implementation).
		413
		414	=head3 Safe/Unsafe Signals
		415
		416	Perl signals can be either "safe" (synchronous to opcode handling) or
		417	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		418	latter might corrupt your memory.
		419
		420	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		421	i.e. they will not interrupt your running perl program but will only be
		422	called as part of the normal event handling (just like timer, I/O etc.
		423	callbacks, too).
		424
385	=head3 Signal Races, Delays and Workarounds	425	=head3 Signal Races, Delays and Workarounds
386		426
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	427	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	428	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	429	do race-free signal handling in perl, requiring C libraries for
		430	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	431	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	432	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	433	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	434	and should be left alone otherwise. This variable determines how often
		435	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	436	will cause fewer spurious wake-ups, which is better for power and CPU
		437	saving.
		438
395	saving. All these problems can be avoided by installing the optional	439	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	440	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>	441	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	442	(and not with L<POE> currently, as POE does it's own workaround with
399	those, you just have to suffer the delays.	443	one-second latency). For those, you just have to suffer the delays.
400		444
401	=head2 CHILD PROCESS WATCHERS	445	=head2 CHILD PROCESS WATCHERS
		446
		447	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
402		448
403	You can also watch on a child process exit and catch its exit status.	449	You can also watch on a child process exit and catch its exit status.
404		450
405	The child process is specified by the C<pid> argument (one some backends,	451	The child process is specified by the C<pid> argument (one some backends,
406	using C<0> watches for any child process exit, on others this will	452	using C<0> watches for any child process exit, on others this will
…		…
455	# do something else, then wait for process exit	501	# do something else, then wait for process exit
456	$done->recv;	502	$done->recv;
457		503
458	=head2 IDLE WATCHERS	504	=head2 IDLE WATCHERS
459		505
460	Sometimes there is a need to do something, but it is not so important	506	$w = AnyEvent->idle (cb => <callback>);
461	to do it instantly, but only when there is nothing better to do. This
462	"nothing better to do" is usually defined to be "no other events need
463	attention by the event loop".
464		507
465	Idle watchers ideally get invoked when the event loop has nothing	508	Repeatedly invoke the callback after the process becomes idle, until
466	better to do, just before it would block the process to wait for new	509	either the watcher is destroyed or new events have been detected.
467	events. Instead of blocking, the idle watcher is invoked.
468		510
469	Most event loops unfortunately do not really support idle watchers (only	511	Idle watchers are useful when there is a need to do something, but it
		512	is not so important (or wise) to do it instantly. The callback will be
		513	invoked only when there is "nothing better to do", which is usually
		514	defined as "all outstanding events have been handled and no new events
		515	have been detected". That means that idle watchers ideally get invoked
		516	when the event loop has just polled for new events but none have been
		517	detected. Instead of blocking to wait for more events, the idle watchers
		518	will be invoked.
		519
		520	Unfortunately, most event loops do not really support idle watchers (only
470	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	521	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
471	will simply call the callback "from time to time".	522	will simply call the callback "from time to time".
472		523
473	Example: read lines from STDIN, but only process them when the	524	Example: read lines from STDIN, but only process them when the
474	program is otherwise idle:	525	program is otherwise idle:
…		…
490	});	541	});
491	});	542	});
492		543
493	=head2 CONDITION VARIABLES	544	=head2 CONDITION VARIABLES
494		545
		546	$cv = AnyEvent->condvar;
		547
		548	$cv->send (<list>);
		549	my @res = $cv->recv;
		550
495	If you are familiar with some event loops you will know that all of them	551	If you are familiar with some event loops you will know that all of them
496	require you to run some blocking "loop", "run" or similar function that	552	require you to run some blocking "loop", "run" or similar function that
497	will actively watch for new events and call your callbacks.	553	will actively watch for new events and call your callbacks.
498		554
499	AnyEvent is slightly different: it expects somebody else to run the event	555	AnyEvent is slightly different: it expects somebody else to run the event
…		…
563	after => 1,	619	after => 1,
564	cb => sub { $result_ready->send },	620	cb => sub { $result_ready->send },
565	);	621	);
566		622
567	# this "blocks" (while handling events) till the callback	623	# this "blocks" (while handling events) till the callback
568	# calls -<send	624	# calls ->send
569	$result_ready->recv;	625	$result_ready->recv;
570		626
571	Example: wait for a timer, but take advantage of the fact that condition	627	Example: wait for a timer, but take advantage of the fact that condition
572	variables are also callable directly.	628	variables are also callable directly.
573		629
…		…
637	one. For example, a function that pings many hosts in parallel might want	693	one. For example, a function that pings many hosts in parallel might want
638	to use a condition variable for the whole process.	694	to use a condition variable for the whole process.
639		695
640	Every call to C<< ->begin >> will increment a counter, and every call to	696	Every call to C<< ->begin >> will increment a counter, and every call to
641	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	697	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
642	>>, the (last) callback passed to C<begin> will be executed. That callback	698	>>, the (last) callback passed to C<begin> will be executed, passing the
643	is I<supposed> to call C<< ->send >>, but that is not required. If no	699	condvar as first argument. That callback is I<supposed> to call C<< ->send
644	callback was set, C<send> will be called without any arguments.	700	>>, but that is not required. If no group callback was set, C<send> will
		701	be called without any arguments.
645		702
646	You can think of C<< $cv->send >> giving you an OR condition (one call	703	You can think of C<< $cv->send >> giving you an OR condition (one call
647	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	704	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
648	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	705	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
649		706
…		…
676	begung can potentially be zero:	733	begung can potentially be zero:
677		734
678	my $cv = AnyEvent->condvar;	735	my $cv = AnyEvent->condvar;
679		736
680	my %result;	737	my %result;
681	$cv->begin (sub { $cv->send (\%result) });	738	$cv->begin (sub { shift->send (\%result) });
682		739
683	for my $host (@list_of_hosts) {	740	for my $host (@list_of_hosts) {
684	$cv->begin;	741	$cv->begin;
685	ping_host_then_call_callback $host, sub {	742	ping_host_then_call_callback $host, sub {
686	$result{$host} = ...;	743	$result{$host} = ...;
…		…
761	=item $cb = $cv->cb ($cb->($cv))	818	=item $cb = $cv->cb ($cb->($cv))
762		819
763	This is a mutator function that returns the callback set and optionally	820	This is a mutator function that returns the callback set and optionally
764	replaces it before doing so.	821	replaces it before doing so.
765		822
766	The callback will be called when the condition becomes "true", i.e. when	823	The callback will be called when the condition becomes (or already was)
767	C<send> or C<croak> are called, with the only argument being the condition	824	"true", i.e. when C<send> or C<croak> are called (or were called), with
768	variable itself. Calling C<recv> inside the callback or at any later time	825	the only argument being the condition variable itself. Calling C<recv>
769	is guaranteed not to block.	826	inside the callback or at any later time is guaranteed not to block.
770		827
771	=back	828	=back
772		829
773	=head1 SUPPORTED EVENT LOOPS/BACKENDS	830	=head1 SUPPORTED EVENT LOOPS/BACKENDS
774		831
…		…
777	=over 4	834	=over 4
778		835
779	=item Backends that are autoprobed when no other event loop can be found.	836	=item Backends that are autoprobed when no other event loop can be found.
780		837
781	EV is the preferred backend when no other event loop seems to be in	838	EV is the preferred backend when no other event loop seems to be in
782	use. If EV is not installed, then AnyEvent will try Event, and, failing	839	use. If EV is not installed, then AnyEvent will fall back to its own
783	that, will fall back to its own pure-perl implementation, which is	840	pure-perl implementation, which is available everywhere as it comes with
784	available everywhere as it comes with AnyEvent itself.	841	AnyEvent itself.
785		842
786	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	843	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
787	AnyEvent::Impl::Event based on Event, very stable, few glitches.
788	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	844	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789		845
790	=item Backends that are transparently being picked up when they are used.	846	=item Backends that are transparently being picked up when they are used.
791		847
792	These will be used when they are currently loaded when the first watcher	848	These will be used when they are currently loaded when the first watcher
793	is created, in which case it is assumed that the application is using	849	is created, in which case it is assumed that the application is using
794	them. This means that AnyEvent will automatically pick the right backend	850	them. This means that AnyEvent will automatically pick the right backend
795	when the main program loads an event module before anything starts to	851	when the main program loads an event module before anything starts to
796	create watchers. Nothing special needs to be done by the main program.	852	create watchers. Nothing special needs to be done by the main program.
797		853
		854	AnyEvent::Impl::Event based on Event, very stable, few glitches.
798	AnyEvent::Impl::Glib based on Glib, slow but very stable.	855	AnyEvent::Impl::Glib based on Glib, slow but very stable.
799	AnyEvent::Impl::Tk based on Tk, very broken.	856	AnyEvent::Impl::Tk based on Tk, very broken.
800	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	857	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801	AnyEvent::Impl::POE based on POE, very slow, some limitations.	858	AnyEvent::Impl::POE based on POE, very slow, some limitations.
802	AnyEvent::Impl::Irssi used when running within irssi.	859	AnyEvent::Impl::Irssi used when running within irssi.
…		…
912	You should check C<$AnyEvent::MODEL> before adding to this array, though:	969	You should check C<$AnyEvent::MODEL> before adding to this array, though:
913	if it is defined then the event loop has already been detected, and the	970	if it is defined then the event loop has already been detected, and the
914	array will be ignored.	971	array will be ignored.
915		972
916	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	973	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
917	it,as it takes care of these details.	974	it, as it takes care of these details.
918		975
919	This variable is mainly useful for modules that can do something useful	976	This variable is mainly useful for modules that can do something useful
920	when AnyEvent is used and thus want to know when it is initialised, but do	977	when AnyEvent is used and thus want to know when it is initialised, but do
921	not need to even load it by default. This array provides the means to hook	978	not need to even load it by default. This array provides the means to hook
922	into AnyEvent passively, without loading it.	979	into AnyEvent passively, without loading it.
		980
		981	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		982	together, you could put this into Coro (this is the actual code used by
		983	Coro to accomplish this):
		984
		985	if (defined $AnyEvent::MODEL) {
		986	# AnyEvent already initialised, so load Coro::AnyEvent
		987	require Coro::AnyEvent;
		988	} else {
		989	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		990	# as soon as it is
		991	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		992	}
923		993
924	=back	994	=back
925		995
926	=head1 WHAT TO DO IN A MODULE	996	=head1 WHAT TO DO IN A MODULE
927		997
…		…
1076		1146
1077	package AnyEvent;	1147	package AnyEvent;
1078		1148
1079	# basically a tuned-down version of common::sense	1149	# basically a tuned-down version of common::sense
1080	sub common_sense {	1150	sub common_sense {
1081	# no warnings	1151	# from common:.sense 1.0
1082	${^WARNING_BITS} ^= ${^WARNING_BITS};	1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1083	# use strict vars subs	1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1084	$^H \|= 0x00000600;	1154	$^H \|= 0x00000600;
1085	}	1155	}
1086		1156
1087	BEGIN { AnyEvent::common_sense }	1157	BEGIN { AnyEvent::common_sense }
1088		1158
1089	use Carp ();	1159	use Carp ();
1090		1160
1091	our $VERSION = 4.881;	1161	our $VERSION = '5.24';
1092	our $MODEL;	1162	our $MODEL;
1093		1163
1094	our $AUTOLOAD;	1164	our $AUTOLOAD;
1095	our @ISA;	1165	our @ISA;
1096		1166
1097	our @REGISTRY;	1167	our @REGISTRY;
1098		1168
1099	our $WIN32;
1100
1101	our $VERBOSE;	1169	our $VERBOSE;
1102		1170
1103	BEGIN {	1171	BEGIN {
		1172	eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";
1104	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1173	eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";
1105	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";
1106		1175
1107	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1108	if ${^TAINT};	1177	if ${^TAINT};
1109		1178
1110	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1122	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1191	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1123	}	1192	}
1124		1193
1125	my @models = (	1194	my @models = (
1126	[EV:: => AnyEvent::Impl::EV:: , 1],	1195	[EV:: => AnyEvent::Impl::EV:: , 1],
1127	[Event:: => AnyEvent::Impl::Event::, 1],
1128	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1196	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129	# everything below here will not (normally) be autoprobed	1197	# everything below here will not (normally) be autoprobed
1130	# as the pureperl backend should work everywhere	1198	# as the pureperl backend should work everywhere
1131	# and is usually faster	1199	# and is usually faster
		1200	[Event:: => AnyEvent::Impl::Event::, 1],
1132	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1201	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1202	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1203	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1204	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1205	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1139	[Prima:: => AnyEvent::Impl::POE::],	1208	[Prima:: => AnyEvent::Impl::POE::],
1140	# IO::Async is just too broken - we would need workarounds for its	1209	# IO::Async is just too broken - we would need workarounds for its
1141	# byzantine signal and broken child handling, among others.	1210	# byzantine signal and broken child handling, among others.
1142	# IO::Async is rather hard to detect, as it doesn't have any	1211	# IO::Async is rather hard to detect, as it doesn't have any
1143	# obvious default class.	1212	# obvious default class.
1144	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1215	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1216	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147	);	1217	);
1148		1218
1149	our %method = map +($_ => 1),	1219	our %method = map +($_ => 1),
1150	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1220	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151		1221
…		…
1258	# we assume CLOEXEC is already set by perl in all important cases	1328	# we assume CLOEXEC is already set by perl in all important cases
1259		1329
1260	($fh2, $rw)	1330	($fh2, $rw)
1261	}	1331	}
1262		1332
		1333	=head1 SIMPLIFIED AE API
		1334
		1335	Starting with version 5.0, AnyEvent officially supports a second, much
		1336	simpler, API that is designed to reduce the calling, typing and memory
		1337	overhead.
		1338
		1339	See the L<AE> manpage for details.
		1340
		1341	=cut
		1342
		1343	package AE;
		1344
		1345	our $VERSION = $AnyEvent::VERSION;
		1346
		1347	sub io($$$) {
		1348	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1349	}
		1350
		1351	sub timer($$$) {
		1352	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1353	}
		1354
		1355	sub signal($$) {
		1356	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1357	}
		1358
		1359	sub child($$) {
		1360	AnyEvent->child (pid => $_[0], cb => $_[1])
		1361	}
		1362
		1363	sub idle($) {
		1364	AnyEvent->idle (cb => $_[0])
		1365	}
		1366
		1367	sub cv(;&) {
		1368	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1369	}
		1370
		1371	sub now() {
		1372	AnyEvent->now
		1373	}
		1374
		1375	sub now_update() {
		1376	AnyEvent->now_update
		1377	}
		1378
		1379	sub time() {
		1380	AnyEvent->time
		1381	}
		1382
1263	package AnyEvent::Base;	1383	package AnyEvent::Base;
1264		1384
1265	# default implementations for many methods	1385	# default implementations for many methods
1266		1386
1267	sub _time {	1387	sub _time() {
1268	# probe for availability of Time::HiRes	1388	# probe for availability of Time::HiRes
1269	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1389	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1390	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1271	*_time = \&Time::HiRes::time;	1391	*_time = \&Time::HiRes::time;
1272	# if (eval "use POSIX (); (POSIX::times())...	1392	# if (eval "use POSIX (); (POSIX::times())...
1273	} else {	1393	} else {
1274	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1394	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1275	*_time = sub { time }; # epic fail	1395	*_time = sub (){ time }; # epic fail
1276	}	1396	}
1277		1397
1278	&_time	1398	&_time
1279	}	1399	}
1280		1400
…		…
1292		1412
1293	our $HAVE_ASYNC_INTERRUPT;	1413	our $HAVE_ASYNC_INTERRUPT;
1294		1414
1295	sub _have_async_interrupt() {	1415	sub _have_async_interrupt() {
1296	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1416	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297	&& eval "use Async::Interrupt 1.0 (); 1")	1417	&& eval "use Async::Interrupt 1.02 (); 1")
1298	unless defined $HAVE_ASYNC_INTERRUPT;	1418	unless defined $HAVE_ASYNC_INTERRUPT;
1299		1419
1300	$HAVE_ASYNC_INTERRUPT	1420	$HAVE_ASYNC_INTERRUPT
1301	}	1421	}
1302		1422
…		…
1305	our ($SIG_COUNT, $SIG_TW);	1425	our ($SIG_COUNT, $SIG_TW);
1306		1426
1307	sub _signal_exec {	1427	sub _signal_exec {
1308	$HAVE_ASYNC_INTERRUPT	1428	$HAVE_ASYNC_INTERRUPT
1309	? $SIGPIPE_R->drain	1429	? $SIGPIPE_R->drain
1310	: sysread $SIGPIPE_R, my $dummy, 9;	1430	: sysread $SIGPIPE_R, (my $dummy), 9;
1311		1431
1312	while (%SIG_EV) {	1432	while (%SIG_EV) {
1313	for (keys %SIG_EV) {	1433	for (keys %SIG_EV) {
1314	delete $SIG_EV{$_};	1434	delete $SIG_EV{$_};
1315	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1435	$_->() for values %{ $SIG_CB{$_} \|\| {} };
…		…
1319		1439
1320	# install a dummy wakeup watcher to reduce signal catching latency	1440	# install a dummy wakeup watcher to reduce signal catching latency
1321	sub _sig_add() {	1441	sub _sig_add() {
1322	unless ($SIG_COUNT++) {	1442	unless ($SIG_COUNT++) {
1323	# try to align timer on a full-second boundary, if possible	1443	# try to align timer on a full-second boundary, if possible
1324	my $NOW = AnyEvent->now;	1444	my $NOW = AE::now;
1325		1445
1326	$SIG_TW = AnyEvent->timer (	1446	$SIG_TW = AE::timer
1327	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1447	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328	interval => $MAX_SIGNAL_LATENCY,	1448	$MAX_SIGNAL_LATENCY,
1329	cb => sub { }, # just for the PERL_ASYNC_CHECK	1449	sub { } # just for the PERL_ASYNC_CHECK
1330	);	1450	;
1331	}	1451	}
1332	}	1452	}
1333		1453
1334	sub _sig_del {	1454	sub _sig_del {
1335	undef $SIG_TW	1455	undef $SIG_TW
1336	unless --$SIG_COUNT;	1456	unless --$SIG_COUNT;
1337	}	1457	}
1338		1458
1339	our %SIGNAME2NUM;
1340	our @SIGNUM2NAME;
1341	our $_sig_name_init; $_sig_name_init = sub {	1459	our $_sig_name_init; $_sig_name_init = sub {
		1460	eval q{ # poor man's autoloading
1342	undef $_sig_name_init;	1461	undef $_sig_name_init;
1343		1462
1344	if (_have_async_interrupt) {	1463	if (_have_async_interrupt) {
1345	*sig2num = \&Async::Interrupt::sig2num;	1464	*sig2num = \&Async::Interrupt::sig2num;
1346	*sig2name = \&Async::Interrupt::sig2name;	1465	*sig2name = \&Async::Interrupt::sig2name;
1347	} else {	1466	} else {
1348	require Config;	1467	require Config;
1349		1468
		1469	my %signame2num;
1350	@SIGNAME2NUM{ split ' ', $Config::Config{sig_name} }	1470	@signame2num{ split ' ', $Config::Config{sig_name} }
1351	= split ' ', $Config::Config{sig_num};	1471	= split ' ', $Config::Config{sig_num};
1352	@SIGNUM2NAME[values %SIGNAME2NUM] = keys %SIGNAME2NUM;
1353		1472
		1473	my @signum2name;
		1474	@signum2name[values %signame2num] = keys %signame2num;
		1475
1354	*sig2num = sub($) {	1476	*sig2num = sub($) {
1355	$_[0] > 0 ? shift : $SIGNAME2NUM{+shift}	1477	$_[0] > 0 ? shift : $signame2num{+shift}
1356	};	1478	};
1357	*sig2name = sub ($) {	1479	*sig2name = sub ($) {
1358	$_[0] > 0 ? $SIGNUM2NAME[+shift] : shift	1480	$_[0] > 0 ? $signum2name[+shift] : shift
		1481	};
1359	};	1482	}
1360	}	1483	};
		1484	die if $@;
1361	};	1485	};
1362		1486
1363	sub sig2num ($) { &$_sig_name_init; &sig2num }	1487	sub sig2num ($) { &$_sig_name_init; &sig2num }
1364	sub sig2name($) { &$_sig_name_init; &sig2name }	1488	sub sig2name($) { &$_sig_name_init; &sig2name }
1365		1489
1366	sub _signal {	1490	sub signal {
		1491	eval q{ # poor man's autoloading {}
		1492	# probe for availability of Async::Interrupt
		1493	if (_have_async_interrupt) {
		1494	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1495
		1496	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1497	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1498
		1499	} else {
		1500	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1501
		1502	require Fcntl;
		1503
		1504	if (AnyEvent::WIN32) {
		1505	require AnyEvent::Util;
		1506
		1507	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1508	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1509	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1510	} else {
		1511	pipe $SIGPIPE_R, $SIGPIPE_W;
		1512	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1513	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1514
		1515	# not strictly required, as $^F is normally 2, but let's make sure...
		1516	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1517	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1518	}
		1519
		1520	$SIGPIPE_R
		1521	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1522
		1523	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1524	}
		1525
		1526	*signal = sub {
1367	my (undef, %arg) = @_;	1527	my (undef, %arg) = @_;
1368		1528
1369	my $signal = uc $arg{signal}	1529	my $signal = uc $arg{signal}
1370	or Carp::croak "required option 'signal' is missing";	1530	or Carp::croak "required option 'signal' is missing";
1371		1531
1372	if ($HAVE_ASYNC_INTERRUPT) {	1532	if ($HAVE_ASYNC_INTERRUPT) {
1373	# async::interrupt	1533	# async::interrupt
1374		1534
1375	$signal = sig2num $signal;	1535	$signal = sig2num $signal;
1376	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1536	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1377		1537
1378	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1538	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1379	cb => sub { undef $SIG_EV{$signal} },	1539	cb => sub { undef $SIG_EV{$signal} },
1380	signal => $signal,	1540	signal => $signal,
1381	pipe => [$SIGPIPE_R->filenos],	1541	pipe => [$SIGPIPE_R->filenos],
1382	pipe_autodrain => 0,	1542	pipe_autodrain => 0,
1383	;	1543	;
1384		1544
1385	} else {	1545	} else {
1386	# pure perl	1546	# pure perl
1387		1547
1388	# AE::Util has been loaded in signal	1548	# AE::Util has been loaded in signal
1389	$signal = sig2name $signal;	1549	$signal = sig2name $signal;
1390	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1550	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1391		1551
1392	$SIG{$signal} \|\|= sub {	1552	$SIG{$signal} \|\|= sub {
1393	local $!;	1553	local $!;
1394	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1554	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1395	undef $SIG_EV{$signal};	1555	undef $SIG_EV{$signal};
		1556	};
		1557
		1558	# can't do signal processing without introducing races in pure perl,
		1559	# so limit the signal latency.
		1560	_sig_add;
		1561	}
		1562
		1563	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1396	};	1564	};
1397		1565
1398	# can't do signal processing without introducing races in pure perl,	1566	*AnyEvent::Base::signal::DESTROY = sub {
1399	# so limit the signal latency.	1567	my ($signal, $cb) = @{$_[0]};
		1568
1400	_sig_add;	1569	_sig_del;
1401	}
1402		1570
1403	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1571	delete $SIG_CB{$signal}{$cb};
1404	}
1405		1572
1406	sub signal {	1573	$HAVE_ASYNC_INTERRUPT
1407	# probe for availability of Async::Interrupt	1574	? delete $SIG_ASY{$signal}
1408	if (_have_async_interrupt) {	1575	: # delete doesn't work with older perls - they then
1409	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1576	# print weird messages, or just unconditionally exit
1410		1577	# instead of getting the default action.
1411	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1578	undef $SIG{$signal}
1412	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1579	unless keys %{ $SIG_CB{$signal} };
1413
1414	} else {
1415	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1416
1417	require Fcntl;
1418
1419	if (AnyEvent::WIN32) {
1420	require AnyEvent::Util;
1421
1422	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1423	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1424	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1425	} else {
1426	pipe $SIGPIPE_R, $SIGPIPE_W;
1427	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1428	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1429
1430	# not strictly required, as $^F is normally 2, but let's make sure...
1431	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1432	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1433	}	1580	};
1434
1435	$SIGPIPE_R
1436	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1437
1438	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1439	}	1581	};
1440		1582	die if $@;
1441	*signal = \&_signal;
1442	&signal	1583	&signal
1443	}
1444
1445	sub AnyEvent::Base::signal::DESTROY {
1446	my ($signal, $cb) = @{$_[0]};
1447
1448	_sig_del;
1449
1450	delete $SIG_CB{$signal}{$cb};
1451
1452	$HAVE_ASYNC_INTERRUPT
1453	? delete $SIG_ASY{$signal}
1454	: # delete doesn't work with older perls - they then
1455	# print weird messages, or just unconditionally exit
1456	# instead of getting the default action.
1457	undef $SIG{$signal}
1458	unless keys %{ $SIG_CB{$signal} };
1459	}	1584	}
1460		1585
1461	# default implementation for ->child	1586	# default implementation for ->child
1462		1587
1463	our %PID_CB;	1588	our %PID_CB;
…		…
1492	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1617	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1493	? 1	1618	? 1
1494	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1619	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1495		1620
1496	unless ($CHLD_W) {	1621	unless ($CHLD_W) {
1497	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1622	$CHLD_W = AE::signal CHLD => \&_sigchld;
1498	# child could be a zombie already, so make at least one round	1623	# child could be a zombie already, so make at least one round
1499	&_sigchld;	1624	&_sigchld;
1500	}	1625	}
1501		1626
1502	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1627	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1528	# never use more then 50% of the time for the idle watcher,	1653	# never use more then 50% of the time for the idle watcher,
1529	# within some limits	1654	# within some limits
1530	$w = 0.0001 if $w < 0.0001;	1655	$w = 0.0001 if $w < 0.0001;
1531	$w = 5 if $w > 5;	1656	$w = 5 if $w > 5;
1532		1657
1533	$w = AnyEvent->timer (after => $w, cb => $rcb);	1658	$w = AE::timer $w, 0, $rcb;
1534	} else {	1659	} else {
1535	# clean up...	1660	# clean up...
1536	undef $w;	1661	undef $w;
1537	undef $rcb;	1662	undef $rcb;
1538	}	1663	}
1539	};	1664	};
1540		1665
1541	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1666	$w = AE::timer 0.05, 0, $rcb;
1542		1667
1543	bless \\$cb, "AnyEvent::Base::idle"	1668	bless \\$cb, "AnyEvent::Base::idle"
1544	}	1669	}
1545		1670
1546	sub AnyEvent::Base::idle::DESTROY {	1671	sub AnyEvent::Base::idle::DESTROY {
…		…
1600	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1725	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1601	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1726	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1602	}	1727	}
1603		1728
1604	sub cb {	1729	sub cb {
1605	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1730	my $cv = shift;
		1731
		1732	@_
		1733	and $cv->{_ae_cb} = shift
		1734	and $cv->{_ae_sent}
		1735	and (delete $cv->{_ae_cb})->($cv);
		1736
1606	$_[0]{_ae_cb}	1737	$cv->{_ae_cb}
1607	}	1738	}
1608		1739
1609	sub begin {	1740	sub begin {
1610	++$_[0]{_ae_counter};	1741	++$_[0]{_ae_counter};
1611	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1742	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1820	warn "read: $input\n"; # output what has been read	1951	warn "read: $input\n"; # output what has been read
1821	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1952	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1822	},	1953	},
1823	);	1954	);
1824		1955
1825	my $time_watcher; # can only be used once
1826
1827	sub new_timer {
1828	$timer = AnyEvent->timer (after => 1, cb => sub {	1956	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1829	warn "timeout\n"; # print 'timeout' about every second	1957	warn "timeout\n"; # print 'timeout' at most every second
1830	&new_timer; # and restart the time
1831	});	1958	});
1832	}
1833
1834	new_timer; # create first timer
1835		1959
1836	$cv->recv; # wait until user enters /^q/i	1960	$cv->recv; # wait until user enters /^q/i
1837		1961
1838	=head1 REAL-WORLD EXAMPLE	1962	=head1 REAL-WORLD EXAMPLE
1839		1963
…		…
1970	through AnyEvent. The benchmark creates a lot of timers (with a zero	2094	through AnyEvent. The benchmark creates a lot of timers (with a zero
1971	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2095	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1972	which it is), lets them fire exactly once and destroys them again.	2096	which it is), lets them fire exactly once and destroys them again.
1973		2097
1974	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2098	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1975	distribution.	2099	distribution. It uses the L<AE> interface, which makes a real difference
		2100	for the EV and Perl backends only.
1976		2101
1977	=head3 Explanation of the columns	2102	=head3 Explanation of the columns
1978		2103
1979	I<watcher> is the number of event watchers created/destroyed. Since	2104	I<watcher> is the number of event watchers created/destroyed. Since
1980	different event models feature vastly different performances, each event	2105	different event models feature vastly different performances, each event
…		…
2001	watcher.	2126	watcher.
2002		2127
2003	=head3 Results	2128	=head3 Results
2004		2129
2005	name watchers bytes create invoke destroy comment	2130	name watchers bytes create invoke destroy comment
2006	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2131	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2007	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2132	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2008	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2133	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2009	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2134	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2010	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2135	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2011	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2136	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2012	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2137	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2013	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2138	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2014	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2139	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2015	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2140	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2016	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2141	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2017	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2142	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2018		2143
2019	=head3 Discussion	2144	=head3 Discussion
2020		2145
2021	The benchmark does I<not> measure scalability of the event loop very	2146	The benchmark does I<not> measure scalability of the event loop very
2022	well. For example, a select-based event loop (such as the pure perl one)	2147	well. For example, a select-based event loop (such as the pure perl one)
…		…
2034	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2159	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2035	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2160	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2036	cycles with POE.	2161	cycles with POE.
2037		2162
2038	C<EV> is the sole leader regarding speed and memory use, which are both	2163	C<EV> is the sole leader regarding speed and memory use, which are both
2039	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2164	maximal/minimal, respectively. When using the L<AE> API there is zero
		2165	overhead (when going through the AnyEvent API create is about 5-6 times
		2166	slower, with other times being equal, so still uses far less memory than
2040	far less memory than any other event loop and is still faster than Event	2167	any other event loop and is still faster than Event natively).
2041	natively.
2042		2168
2043	The pure perl implementation is hit in a few sweet spots (both the	2169	The pure perl implementation is hit in a few sweet spots (both the
2044	constant timeout and the use of a single fd hit optimisations in the perl	2170	constant timeout and the use of a single fd hit optimisations in the perl
2045	interpreter and the backend itself). Nevertheless this shows that it	2171	interpreter and the backend itself). Nevertheless this shows that it
2046	adds very little overhead in itself. Like any select-based backend its	2172	adds very little overhead in itself. Like any select-based backend its
…		…
2120	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2246	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2121	(1%) are active. This mirrors the activity of large servers with many	2247	(1%) are active. This mirrors the activity of large servers with many
2122	connections, most of which are idle at any one point in time.	2248	connections, most of which are idle at any one point in time.
2123		2249
2124	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2250	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2125	distribution.	2251	distribution. It uses the L<AE> interface, which makes a real difference
		2252	for the EV and Perl backends only.
2126		2253
2127	=head3 Explanation of the columns	2254	=head3 Explanation of the columns
2128		2255
2129	I<sockets> is the number of sockets, and twice the number of "servers" (as	2256	I<sockets> is the number of sockets, and twice the number of "servers" (as
2130	each server has a read and write socket end).	2257	each server has a read and write socket end).
…		…
2138	a new one that moves the timeout into the future.	2265	a new one that moves the timeout into the future.
2139		2266
2140	=head3 Results	2267	=head3 Results
2141		2268
2142	name sockets create request	2269	name sockets create request
2143	EV 20000 69.01 11.16	2270	EV 20000 62.66 7.99
2144	Perl 20000 73.32 35.87	2271	Perl 20000 68.32 32.64
2145	IOAsync 20000 157.00 98.14 epoll	2272	IOAsync 20000 174.06 101.15 epoll
2146	IOAsync 20000 159.31 616.06 poll	2273	IOAsync 20000 174.67 610.84 poll
2147	Event 20000 212.62 257.32	2274	Event 20000 202.69 242.91
2148	Glib 20000 651.16 1896.30	2275	Glib 20000 557.01 1689.52
2149	POE 20000 349.67 12317.24 uses POE::Loop::Event	2276	POE 20000 341.54 12086.32 uses POE::Loop::Event
2150		2277
2151	=head3 Discussion	2278	=head3 Discussion
2152		2279
2153	This benchmark I<does> measure scalability and overall performance of the	2280	This benchmark I<does> measure scalability and overall performance of the
2154	particular event loop.	2281	particular event loop.
…		…
2280	As you can see, the AnyEvent + EV combination even beats the	2407	As you can see, the AnyEvent + EV combination even beats the
2281	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2408	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2282	backend easily beats IO::Lambda and POE.	2409	backend easily beats IO::Lambda and POE.
2283		2410
2284	And even the 100% non-blocking version written using the high-level (and	2411	And even the 100% non-blocking version written using the high-level (and
2285	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2412	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2286	large margin, even though it does all of DNS, tcp-connect and socket I/O	2413	higher level ("unoptimised") abstractions by a large margin, even though
2287	in a non-blocking way.	2414	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2288		2415
2289	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2416	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2290	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2417	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2291	part of the IO::lambda distribution and were used without any changes.	2418	part of the IO::Lambda distribution and were used without any changes.
2292		2419
2293		2420
2294	=head1 SIGNALS	2421	=head1 SIGNALS
2295		2422
2296	AnyEvent currently installs handlers for these signals:	2423	AnyEvent currently installs handlers for these signals:
…		…
2338	it's built-in modules) are required to use it.	2465	it's built-in modules) are required to use it.
2339		2466
2340	That does not mean that AnyEvent won't take advantage of some additional	2467	That does not mean that AnyEvent won't take advantage of some additional
2341	modules if they are installed.	2468	modules if they are installed.
2342		2469
2343	This section epxlains which additional modules will be used, and how they	2470	This section explains which additional modules will be used, and how they
2344	affect AnyEvent's operetion.	2471	affect AnyEvent's operation.
2345		2472
2346	=over 4	2473	=over 4
2347		2474
2348	=item L<Async::Interrupt>	2475	=item L<Async::Interrupt>
2349		2476
…		…
2354	catch the signals) with some delay (default is 10 seconds, look for	2481	catch the signals) with some delay (default is 10 seconds, look for
2355	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2482	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2356		2483
2357	If this module is available, then it will be used to implement signal	2484	If this module is available, then it will be used to implement signal
2358	catching, which means that signals will not be delayed, and the event loop	2485	catching, which means that signals will not be delayed, and the event loop
2359	will not be interrupted regularly, which is more efficient (And good for	2486	will not be interrupted regularly, which is more efficient (and good for
2360	battery life on laptops).	2487	battery life on laptops).
2361		2488
2362	This affects not just the pure-perl event loop, but also other event loops	2489	This affects not just the pure-perl event loop, but also other event loops
2363	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2490	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2364		2491
…		…
2385	lot less memory), but otherwise doesn't affect guard operation much. It is	2512	lot less memory), but otherwise doesn't affect guard operation much. It is
2386	purely used for performance.	2513	purely used for performance.
2387		2514
2388	=item L<JSON> and L<JSON::XS>	2515	=item L<JSON> and L<JSON::XS>
2389		2516
2390	This module is required when you want to read or write JSON data via	2517	One of these modules is required when you want to read or write JSON data
2391	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2518	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2392	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2519	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2393		2520
2394	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2521	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2395	installed.	2522	installed.
2396		2523
…		…
2411		2538
2412		2539
2413	=head1 FORK	2540	=head1 FORK
2414		2541
2415	Most event libraries are not fork-safe. The ones who are usually are	2542	Most event libraries are not fork-safe. The ones who are usually are
2416	because they rely on inefficient but fork-safe C<select> or C<poll>	2543	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2417	calls. Only L<EV> is fully fork-aware.	2544	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2545	are usually badly thought-out hacks that are incompatible with fork in
		2546	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2547	continue event-processing in both parent and child (or both, if you know
		2548	what you are doing).
		2549
		2550	This means that, in general, you cannot fork and do event processing in
		2551	the child if the event library was initialised before the fork (which
		2552	usually happens when the first AnyEvent watcher is created, or the library
		2553	is loaded).
2418		2554
2419	If you have to fork, you must either do so I<before> creating your first	2555	If you have to fork, you must either do so I<before> creating your first
2420	watcher OR you must not use AnyEvent at all in the child OR you must do	2556	watcher OR you must not use AnyEvent at all in the child OR you must do
2421	something completely out of the scope of AnyEvent.	2557	something completely out of the scope of AnyEvent.
		2558
		2559	The problem of doing event processing in the parent I<and> the child
		2560	is much more complicated: even for backends that I<are> fork-aware or
		2561	fork-safe, their behaviour is not usually what you want: fork clones all
		2562	watchers, that means all timers, I/O watchers etc. are active in both
		2563	parent and child, which is almost never what you want. USing C<exec>
		2564	to start worker children from some kind of manage rprocess is usually
		2565	preferred, because it is much easier and cleaner, at the expense of having
		2566	to have another binary.
2422		2567
2423		2568
2424	=head1 SECURITY CONSIDERATIONS	2569	=head1 SECURITY CONSIDERATIONS
2425		2570
2426	AnyEvent can be forced to load any event model via	2571	AnyEvent can be forced to load any event model via

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.263 by root, Wed Jul 29 12:39:21 2009 UTC vs. Revision 1.311 by root, Wed Feb 10 13:33:44 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.263 by root, Wed Jul 29 12:39:21 2009 UTC vs.
Revision 1.311 by root, Wed Feb 10 13:33:44 2010 UTC