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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.259 by root, Tue Jul 28 02:07:18 2009 UTC vs.
Revision 1.296 by root, Tue Nov 17 01:19:49 2009 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
…		…
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		407
385	=head3 Signal Races, Delays and Workarounds	408	=head3 Signal Races, Delays and Workarounds
386		409
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	410	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388	callbacks to signals in a generic way, which is a pity, as you cannot do	411	callbacks to signals in a generic way, which is a pity, as you cannot
389	race-free signal handling in perl. AnyEvent will try to do it's best, but	412	do race-free signal handling in perl, requiring C libraries for
		413	this. AnyEvent will try to do it's best, which means in some cases,
390	in some cases, signals will be delayed. The maximum time a signal might	414	signals will be delayed. The maximum time a signal might be delayed is
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	415	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	416	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	417	and should be left alone otherwise. This variable determines how often
		418	AnyEvent polls for signals (in case a wake-up was missed). Higher values
394	will cause fewer spurious wake-ups, which is better for power and CPU	419	will cause fewer spurious wake-ups, which is better for power and CPU
		420	saving.
		421
395	saving. All these problems can be avoided by installing the optional	422	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	423	L<Async::Interrupt> module, which works with most event loops. It will not
397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	424	work with inherently broken event loops such as L<Event> or L<Event::Lib>
398	currently, as POE does it's own workaround with one-second latency). With	425	(and not with L<POE> currently, as POE does it's own workaround with
399	those, you just have to suffer the delays.	426	one-second latency). For those, you just have to suffer the delays.
400		427
401	=head2 CHILD PROCESS WATCHERS	428	=head2 CHILD PROCESS WATCHERS
		429
		430	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
402		431
403	You can also watch on a child process exit and catch its exit status.	432	You can also watch on a child process exit and catch its exit status.
404		433
405	The child process is specified by the C<pid> argument (one some backends,	434	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	435	using C<0> watches for any child process exit, on others this will
…		…
455	# do something else, then wait for process exit	484	# do something else, then wait for process exit
456	$done->recv;	485	$done->recv;
457		486
458	=head2 IDLE WATCHERS	487	=head2 IDLE WATCHERS
459		488
		489	$w = AnyEvent->idle (cb => <callback>);
		490
460	Sometimes there is a need to do something, but it is not so important	491	Sometimes there is a need to do something, but it is not so important
461	to do it instantly, but only when there is nothing better to do. This	492	to do it instantly, but only when there is nothing better to do. This
462	"nothing better to do" is usually defined to be "no other events need	493	"nothing better to do" is usually defined to be "no other events need
463	attention by the event loop".	494	attention by the event loop".
464		495
…		…
490	});	521	});
491	});	522	});
492		523
493	=head2 CONDITION VARIABLES	524	=head2 CONDITION VARIABLES
494		525
		526	$cv = AnyEvent->condvar;
		527
		528	$cv->send (<list>);
		529	my @res = $cv->recv;
		530
495	If you are familiar with some event loops you will know that all of them	531	If you are familiar with some event loops you will know that all of them
496	require you to run some blocking "loop", "run" or similar function that	532	require you to run some blocking "loop", "run" or similar function that
497	will actively watch for new events and call your callbacks.	533	will actively watch for new events and call your callbacks.
498		534
499	AnyEvent is slightly different: it expects somebody else to run the event	535	AnyEvent is slightly different: it expects somebody else to run the event
…		…
563	after => 1,	599	after => 1,
564	cb => sub { $result_ready->send },	600	cb => sub { $result_ready->send },
565	);	601	);
566		602
567	# this "blocks" (while handling events) till the callback	603	# this "blocks" (while handling events) till the callback
568	# calls -<send	604	# calls ->send
569	$result_ready->recv;	605	$result_ready->recv;
570		606
571	Example: wait for a timer, but take advantage of the fact that condition	607	Example: wait for a timer, but take advantage of the fact that condition
572	variables are also callable directly.	608	variables are also callable directly.
573		609
…		…
637	one. For example, a function that pings many hosts in parallel might want	673	one. For example, a function that pings many hosts in parallel might want
638	to use a condition variable for the whole process.	674	to use a condition variable for the whole process.
639		675
640	Every call to C<< ->begin >> will increment a counter, and every call to	676	Every call to C<< ->begin >> will increment a counter, and every call to
641	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	677	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
642	>>, the (last) callback passed to C<begin> will be executed. That callback	678	>>, the (last) callback passed to C<begin> will be executed, passing the
643	is I<supposed> to call C<< ->send >>, but that is not required. If no	679	condvar as first argument. That callback is I<supposed> to call C<< ->send
644	callback was set, C<send> will be called without any arguments.	680	>>, but that is not required. If no group callback was set, C<send> will
		681	be called without any arguments.
645		682
646	You can think of C<< $cv->send >> giving you an OR condition (one call	683	You can think of C<< $cv->send >> giving you an OR condition (one call
647	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	684	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
648	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	685	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
649		686
…		…
676	begung can potentially be zero:	713	begung can potentially be zero:
677		714
678	my $cv = AnyEvent->condvar;	715	my $cv = AnyEvent->condvar;
679		716
680	my %result;	717	my %result;
681	$cv->begin (sub { $cv->send (\%result) });	718	$cv->begin (sub { shift->send (\%result) });
682		719
683	for my $host (@list_of_hosts) {	720	for my $host (@list_of_hosts) {
684	$cv->begin;	721	$cv->begin;
685	ping_host_then_call_callback $host, sub {	722	ping_host_then_call_callback $host, sub {
686	$result{$host} = ...;	723	$result{$host} = ...;
…		…
761	=item $cb = $cv->cb ($cb->($cv))	798	=item $cb = $cv->cb ($cb->($cv))
762		799
763	This is a mutator function that returns the callback set and optionally	800	This is a mutator function that returns the callback set and optionally
764	replaces it before doing so.	801	replaces it before doing so.
765		802
766	The callback will be called when the condition becomes "true", i.e. when	803	The callback will be called when the condition becomes (or already was)
767	C<send> or C<croak> are called, with the only argument being the condition	804	"true", i.e. when C<send> or C<croak> are called (or were called), with
768	variable itself. Calling C<recv> inside the callback or at any later time	805	the only argument being the condition variable itself. Calling C<recv>
769	is guaranteed not to block.	806	inside the callback or at any later time is guaranteed not to block.
770		807
771	=back	808	=back
772		809
773	=head1 SUPPORTED EVENT LOOPS/BACKENDS	810	=head1 SUPPORTED EVENT LOOPS/BACKENDS
774		811
…		…
777	=over 4	814	=over 4
778		815
779	=item Backends that are autoprobed when no other event loop can be found.	816	=item Backends that are autoprobed when no other event loop can be found.
780		817
781	EV is the preferred backend when no other event loop seems to be in	818	EV is the preferred backend when no other event loop seems to be in
782	use. If EV is not installed, then AnyEvent will try Event, and, failing	819	use. If EV is not installed, then AnyEvent will fall back to its own
783	that, will fall back to its own pure-perl implementation, which is	820	pure-perl implementation, which is available everywhere as it comes with
784	available everywhere as it comes with AnyEvent itself.	821	AnyEvent itself.
785		822
786	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	823	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.	824	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789		825
790	=item Backends that are transparently being picked up when they are used.	826	=item Backends that are transparently being picked up when they are used.
791		827
792	These will be used when they are currently loaded when the first watcher	828	These will be used when they are currently loaded when the first watcher
793	is created, in which case it is assumed that the application is using	829	is created, in which case it is assumed that the application is using
794	them. This means that AnyEvent will automatically pick the right backend	830	them. This means that AnyEvent will automatically pick the right backend
795	when the main program loads an event module before anything starts to	831	when the main program loads an event module before anything starts to
796	create watchers. Nothing special needs to be done by the main program.	832	create watchers. Nothing special needs to be done by the main program.
797		833
		834	AnyEvent::Impl::Event based on Event, very stable, few glitches.
798	AnyEvent::Impl::Glib based on Glib, slow but very stable.	835	AnyEvent::Impl::Glib based on Glib, slow but very stable.
799	AnyEvent::Impl::Tk based on Tk, very broken.	836	AnyEvent::Impl::Tk based on Tk, very broken.
800	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	837	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801	AnyEvent::Impl::POE based on POE, very slow, some limitations.	838	AnyEvent::Impl::POE based on POE, very slow, some limitations.
802	AnyEvent::Impl::Irssi used when running within irssi.	839	AnyEvent::Impl::Irssi used when running within irssi.
…		…
1076		1113
1077	package AnyEvent;	1114	package AnyEvent;
1078		1115
1079	# basically a tuned-down version of common::sense	1116	# basically a tuned-down version of common::sense
1080	sub common_sense {	1117	sub common_sense {
1081	# no warnings	1118	# from common:.sense 1.0
1082	${^WARNING_BITS} ^= ${^WARNING_BITS};	1119	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1083	# use strict vars subs	1120	# use strict vars subs
1084	$^H \|= 0x00000600;	1121	$^H \|= 0x00000600;
1085	}	1122	}
1086		1123
1087	BEGIN { AnyEvent::common_sense }	1124	BEGIN { AnyEvent::common_sense }
1088		1125
1089	use Carp ();	1126	use Carp ();
1090		1127
1091	our $VERSION = 4.88;	1128	our $VERSION = '5.202';
1092	our $MODEL;	1129	our $MODEL;
1093		1130
1094	our $AUTOLOAD;	1131	our $AUTOLOAD;
1095	our @ISA;	1132	our @ISA;
1096		1133
…		…
1122	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1159	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1123	}	1160	}
1124		1161
1125	my @models = (	1162	my @models = (
1126	[EV:: => AnyEvent::Impl::EV:: , 1],	1163	[EV:: => AnyEvent::Impl::EV:: , 1],
1127	[Event:: => AnyEvent::Impl::Event::, 1],
1128	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1164	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129	# everything below here will not (normally) be autoprobed	1165	# everything below here will not (normally) be autoprobed
1130	# as the pureperl backend should work everywhere	1166	# as the pureperl backend should work everywhere
1131	# and is usually faster	1167	# and is usually faster
		1168	[Event:: => AnyEvent::Impl::Event::, 1],
1132	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1169	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1170	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1171	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1172	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1173	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1139	[Prima:: => AnyEvent::Impl::POE::],	1176	[Prima:: => AnyEvent::Impl::POE::],
1140	# IO::Async is just too broken - we would need workarounds for its	1177	# IO::Async is just too broken - we would need workarounds for its
1141	# byzantine signal and broken child handling, among others.	1178	# byzantine signal and broken child handling, among others.
1142	# IO::Async is rather hard to detect, as it doesn't have any	1179	# IO::Async is rather hard to detect, as it doesn't have any
1143	# obvious default class.	1180	# obvious default class.
1144	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1181	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1182	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1183	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1184	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147	);	1185	);
1148		1186
1149	our %method = map +($_ => 1),	1187	our %method = map +($_ => 1),
1150	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1188	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151		1189
…		…
1258	# we assume CLOEXEC is already set by perl in all important cases	1296	# we assume CLOEXEC is already set by perl in all important cases
1259		1297
1260	($fh2, $rw)	1298	($fh2, $rw)
1261	}	1299	}
1262		1300
		1301	=head1 SIMPLIFIED AE API
		1302
		1303	Starting with version 5.0, AnyEvent officially supports a second, much
		1304	simpler, API that is designed to reduce the calling, typing and memory
		1305	overhead.
		1306
		1307	See the L<AE> manpage for details.
		1308
		1309	=cut
		1310
		1311	package AE;
		1312
		1313	our $VERSION = $AnyEvent::VERSION;
		1314
		1315	sub io($$$) {
		1316	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1317	}
		1318
		1319	sub timer($$$) {
		1320	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1321	}
		1322
		1323	sub signal($$) {
		1324	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1325	}
		1326
		1327	sub child($$) {
		1328	AnyEvent->child (pid => $_[0], cb => $_[1])
		1329	}
		1330
		1331	sub idle($) {
		1332	AnyEvent->idle (cb => $_[0])
		1333	}
		1334
		1335	sub cv(;&) {
		1336	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1337	}
		1338
		1339	sub now() {
		1340	AnyEvent->now
		1341	}
		1342
		1343	sub now_update() {
		1344	AnyEvent->now_update
		1345	}
		1346
		1347	sub time() {
		1348	AnyEvent->time
		1349	}
		1350
1263	package AnyEvent::Base;	1351	package AnyEvent::Base;
1264		1352
1265	# default implementations for many methods	1353	# default implementations for many methods
1266		1354
1267	sub _time {	1355	sub _time() {
1268	# probe for availability of Time::HiRes	1356	# probe for availability of Time::HiRes
1269	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1357	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1358	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1271	*_time = \&Time::HiRes::time;	1359	*_time = \&Time::HiRes::time;
1272	# if (eval "use POSIX (); (POSIX::times())...	1360	# if (eval "use POSIX (); (POSIX::times())...
…		…
1289	}	1377	}
1290		1378
1291	# default implementation for ->signal	1379	# default implementation for ->signal
1292		1380
1293	our $HAVE_ASYNC_INTERRUPT;	1381	our $HAVE_ASYNC_INTERRUPT;
		1382
		1383	sub _have_async_interrupt() {
		1384	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1385	&& eval "use Async::Interrupt 1.02 (); 1")
		1386	unless defined $HAVE_ASYNC_INTERRUPT;
		1387
		1388	$HAVE_ASYNC_INTERRUPT
		1389	}
		1390
1294	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1391	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1295	our (%SIG_ASY, %SIG_ASY_W);	1392	our (%SIG_ASY, %SIG_ASY_W);
1296	our ($SIG_COUNT, $SIG_TW);	1393	our ($SIG_COUNT, $SIG_TW);
1297		1394
1298	sub _signal_exec {	1395	sub _signal_exec {
1299	$HAVE_ASYNC_INTERRUPT	1396	$HAVE_ASYNC_INTERRUPT
1300	? $SIGPIPE_R->drain	1397	? $SIGPIPE_R->drain
1301	: sysread $SIGPIPE_R, my $dummy, 9;	1398	: sysread $SIGPIPE_R, (my $dummy), 9;
1302		1399
1303	while (%SIG_EV) {	1400	while (%SIG_EV) {
1304	for (keys %SIG_EV) {	1401	for (keys %SIG_EV) {
1305	delete $SIG_EV{$_};	1402	delete $SIG_EV{$_};
1306	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1403	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1307	}	1404	}
1308	}	1405	}
1309	}	1406	}
1310		1407
1311	# install a dumym wakeupw atcher to reduce signal catching latency	1408	# install a dummy wakeup watcher to reduce signal catching latency
1312	sub _sig_add() {	1409	sub _sig_add() {
1313	unless ($SIG_COUNT++) {	1410	unless ($SIG_COUNT++) {
1314	# try to align timer on a full-second boundary, if possible	1411	# try to align timer on a full-second boundary, if possible
1315	my $NOW = AnyEvent->now;	1412	my $NOW = AE::now;
1316		1413
1317	$SIG_TW = AnyEvent->timer (	1414	$SIG_TW = AE::timer
1318	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1415	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1319	interval => $MAX_SIGNAL_LATENCY,	1416	$MAX_SIGNAL_LATENCY,
1320	cb => sub { }, # just for the PERL_ASYNC_CHECK	1417	sub { } # just for the PERL_ASYNC_CHECK
1321	);	1418	;
1322	}	1419	}
1323	}	1420	}
1324		1421
1325	sub _sig_del {	1422	sub _sig_del {
1326	undef $SIG_TW	1423	undef $SIG_TW
1327	unless --$SIG_COUNT;	1424	unless --$SIG_COUNT;
1328	}	1425	}
1329		1426
		1427	our $_sig_name_init; $_sig_name_init = sub {
		1428	eval q{ # poor man's autoloading
		1429	undef $_sig_name_init;
		1430
		1431	if (_have_async_interrupt) {
		1432	*sig2num = \&Async::Interrupt::sig2num;
		1433	*sig2name = \&Async::Interrupt::sig2name;
		1434	} else {
		1435	require Config;
		1436
		1437	my %signame2num;
		1438	@signame2num{ split ' ', $Config::Config{sig_name} }
		1439	= split ' ', $Config::Config{sig_num};
		1440
		1441	my @signum2name;
		1442	@signum2name[values %signame2num] = keys %signame2num;
		1443
		1444	*sig2num = sub($) {
		1445	$_[0] > 0 ? shift : $signame2num{+shift}
		1446	};
		1447	*sig2name = sub ($) {
		1448	$_[0] > 0 ? $signum2name[+shift] : shift
		1449	};
		1450	}
		1451	};
		1452	die if $@;
		1453	};
		1454
		1455	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1456	sub sig2name($) { &$_sig_name_init; &sig2name }
		1457
1330	sub _signal {	1458	sub signal {
		1459	eval q{ # poor man's autoloading {}
		1460	# probe for availability of Async::Interrupt
		1461	if (_have_async_interrupt) {
		1462	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1463
		1464	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1465	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1466
		1467	} else {
		1468	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1469
		1470	require Fcntl;
		1471
		1472	if (AnyEvent::WIN32) {
		1473	require AnyEvent::Util;
		1474
		1475	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1476	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1477	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1478	} else {
		1479	pipe $SIGPIPE_R, $SIGPIPE_W;
		1480	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1481	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1482
		1483	# not strictly required, as $^F is normally 2, but let's make sure...
		1484	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1485	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1486	}
		1487
		1488	$SIGPIPE_R
		1489	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1490
		1491	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1492	}
		1493
		1494	*signal = sub {
1331	my (undef, %arg) = @_;	1495	my (undef, %arg) = @_;
1332		1496
1333	my $signal = uc $arg{signal}	1497	my $signal = uc $arg{signal}
1334	or Carp::croak "required option 'signal' is missing";	1498	or Carp::croak "required option 'signal' is missing";
1335		1499
1336	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1337
1338	if ($HAVE_ASYNC_INTERRUPT) {	1500	if ($HAVE_ASYNC_INTERRUPT) {
1339	# async::interrupt	1501	# async::interrupt
1340		1502
1341	$SIG_ASY{$signal} \|\|= do {	1503	$signal = sig2num $signal;
1342	my $asy = new Async::Interrupt	1504	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1505
		1506	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1343	cb => sub { undef $SIG_EV{$signal} },	1507	cb => sub { undef $SIG_EV{$signal} },
1344	signal => $signal,	1508	signal => $signal,
1345	pipe => [$SIGPIPE_R->filenos],	1509	pipe => [$SIGPIPE_R->filenos],
		1510	pipe_autodrain => 0,
		1511	;
		1512
		1513	} else {
		1514	# pure perl
		1515
		1516	# AE::Util has been loaded in signal
		1517	$signal = sig2name $signal;
		1518	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1519
		1520	$SIG{$signal} \|\|= sub {
		1521	local $!;
		1522	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1523	undef $SIG_EV{$signal};
		1524	};
		1525
		1526	# can't do signal processing without introducing races in pure perl,
		1527	# so limit the signal latency.
		1528	_sig_add;
1346	;	1529	}
1347	$asy->pipe_autodrain (0);
1348		1530
1349	$asy	1531	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1350	};	1532	};
1351		1533
1352	} else {	1534	*AnyEvent::Base::signal::DESTROY = sub {
1353	# pure perl	1535	my ($signal, $cb) = @{$_[0]};
1354		1536
1355	$SIG{$signal} \|\|= sub {	1537	_sig_del;
1356	local $!;	1538
1357	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1539	delete $SIG_CB{$signal}{$cb};
		1540
		1541	$HAVE_ASYNC_INTERRUPT
		1542	? delete $SIG_ASY{$signal}
		1543	: # delete doesn't work with older perls - they then
		1544	# print weird messages, or just unconditionally exit
		1545	# instead of getting the default action.
1358	undef $SIG_EV{$signal};	1546	undef $SIG{$signal}
		1547	unless keys %{ $SIG_CB{$signal} };
1359	};	1548	};
1360
1361	# can't do signal processing without introducing races in pure perl,
1362	# so limit the signal latency.
1363	_sig_add;
1364	}	1549	};
1365		1550	die if $@;
1366	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1367	}
1368
1369	sub signal {
1370	# probe for availability of Async::Interrupt
1371	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1372	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1373
1374	$HAVE_ASYNC_INTERRUPT = 1;
1375	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1376	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1377
1378	} else {
1379	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1380
1381	require Fcntl;
1382
1383	if (AnyEvent::WIN32) {
1384	require AnyEvent::Util;
1385
1386	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1387	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1388	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1389	} else {
1390	pipe $SIGPIPE_R, $SIGPIPE_W;
1391	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1392	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1393
1394	# not strictly required, as $^F is normally 2, but let's make sure...
1395	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1396	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1397	}
1398
1399	$SIGPIPE_R
1400	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1401
1402	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1403	}
1404
1405	*signal = \&_signal;
1406	&signal	1551	&signal
1407	}
1408
1409	sub AnyEvent::Base::signal::DESTROY {
1410	my ($signal, $cb) = @{$_[0]};
1411
1412	_sig_del;
1413
1414	delete $SIG_CB{$signal}{$cb};
1415
1416	$HAVE_ASYNC_INTERRUPT
1417	? delete $SIG_ASY{$signal}
1418	: # delete doesn't work with older perls - they then
1419	# print weird messages, or just unconditionally exit
1420	# instead of getting the default action.
1421	undef $SIG{$signal}
1422	unless keys %{ $SIG_CB{$signal} };
1423	}	1552	}
1424		1553
1425	# default implementation for ->child	1554	# default implementation for ->child
1426		1555
1427	our %PID_CB;	1556	our %PID_CB;
…		…
1456	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1585	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1457	? 1	1586	? 1
1458	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1587	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1459		1588
1460	unless ($CHLD_W) {	1589	unless ($CHLD_W) {
1461	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1590	$CHLD_W = AE::signal CHLD => \&_sigchld;
1462	# child could be a zombie already, so make at least one round	1591	# child could be a zombie already, so make at least one round
1463	&_sigchld;	1592	&_sigchld;
1464	}	1593	}
1465		1594
1466	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1595	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1492	# never use more then 50% of the time for the idle watcher,	1621	# never use more then 50% of the time for the idle watcher,
1493	# within some limits	1622	# within some limits
1494	$w = 0.0001 if $w < 0.0001;	1623	$w = 0.0001 if $w < 0.0001;
1495	$w = 5 if $w > 5;	1624	$w = 5 if $w > 5;
1496		1625
1497	$w = AnyEvent->timer (after => $w, cb => $rcb);	1626	$w = AE::timer $w, 0, $rcb;
1498	} else {	1627	} else {
1499	# clean up...	1628	# clean up...
1500	undef $w;	1629	undef $w;
1501	undef $rcb;	1630	undef $rcb;
1502	}	1631	}
1503	};	1632	};
1504		1633
1505	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1634	$w = AE::timer 0.05, 0, $rcb;
1506		1635
1507	bless \\$cb, "AnyEvent::Base::idle"	1636	bless \\$cb, "AnyEvent::Base::idle"
1508	}	1637	}
1509		1638
1510	sub AnyEvent::Base::idle::DESTROY {	1639	sub AnyEvent::Base::idle::DESTROY {
…		…
1564	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1693	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1565	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1694	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1566	}	1695	}
1567		1696
1568	sub cb {	1697	sub cb {
1569	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1698	my $cv = shift;
		1699
		1700	@_
		1701	and $cv->{_ae_cb} = shift
		1702	and $cv->{_ae_sent}
		1703	and (delete $cv->{_ae_cb})->($cv);
		1704
1570	$_[0]{_ae_cb}	1705	$cv->{_ae_cb}
1571	}	1706	}
1572		1707
1573	sub begin {	1708	sub begin {
1574	++$_[0]{_ae_counter};	1709	++$_[0]{_ae_counter};
1575	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1710	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1784	warn "read: $input\n"; # output what has been read	1919	warn "read: $input\n"; # output what has been read
1785	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1920	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1786	},	1921	},
1787	);	1922	);
1788		1923
1789	my $time_watcher; # can only be used once
1790
1791	sub new_timer {
1792	$timer = AnyEvent->timer (after => 1, cb => sub {	1924	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1793	warn "timeout\n"; # print 'timeout' about every second	1925	warn "timeout\n"; # print 'timeout' at most every second
1794	&new_timer; # and restart the time
1795	});	1926	});
1796	}
1797
1798	new_timer; # create first timer
1799		1927
1800	$cv->recv; # wait until user enters /^q/i	1928	$cv->recv; # wait until user enters /^q/i
1801		1929
1802	=head1 REAL-WORLD EXAMPLE	1930	=head1 REAL-WORLD EXAMPLE
1803		1931
…		…
1934	through AnyEvent. The benchmark creates a lot of timers (with a zero	2062	through AnyEvent. The benchmark creates a lot of timers (with a zero
1935	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2063	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1936	which it is), lets them fire exactly once and destroys them again.	2064	which it is), lets them fire exactly once and destroys them again.
1937		2065
1938	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2066	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1939	distribution.	2067	distribution. It uses the L<AE> interface, which makes a real difference
		2068	for the EV and Perl backends only.
1940		2069
1941	=head3 Explanation of the columns	2070	=head3 Explanation of the columns
1942		2071
1943	I<watcher> is the number of event watchers created/destroyed. Since	2072	I<watcher> is the number of event watchers created/destroyed. Since
1944	different event models feature vastly different performances, each event	2073	different event models feature vastly different performances, each event
…		…
1965	watcher.	2094	watcher.
1966		2095
1967	=head3 Results	2096	=head3 Results
1968		2097
1969	name watchers bytes create invoke destroy comment	2098	name watchers bytes create invoke destroy comment
1970	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2099	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1971	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2100	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1972	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2101	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1973	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2102	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1974	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2103	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1975	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2104	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1976	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2105	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1977	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2106	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1978	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2107	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1979	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2108	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1980	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2109	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1981	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2110	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1982		2111
1983	=head3 Discussion	2112	=head3 Discussion
1984		2113
1985	The benchmark does I<not> measure scalability of the event loop very	2114	The benchmark does I<not> measure scalability of the event loop very
1986	well. For example, a select-based event loop (such as the pure perl one)	2115	well. For example, a select-based event loop (such as the pure perl one)
…		…
1998	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2127	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1999	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2128	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2000	cycles with POE.	2129	cycles with POE.
2001		2130
2002	C<EV> is the sole leader regarding speed and memory use, which are both	2131	C<EV> is the sole leader regarding speed and memory use, which are both
2003	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2132	maximal/minimal, respectively. When using the L<AE> API there is zero
		2133	overhead (when going through the AnyEvent API create is about 5-6 times
		2134	slower, with other times being equal, so still uses far less memory than
2004	far less memory than any other event loop and is still faster than Event	2135	any other event loop and is still faster than Event natively).
2005	natively.
2006		2136
2007	The pure perl implementation is hit in a few sweet spots (both the	2137	The pure perl implementation is hit in a few sweet spots (both the
2008	constant timeout and the use of a single fd hit optimisations in the perl	2138	constant timeout and the use of a single fd hit optimisations in the perl
2009	interpreter and the backend itself). Nevertheless this shows that it	2139	interpreter and the backend itself). Nevertheless this shows that it
2010	adds very little overhead in itself. Like any select-based backend its	2140	adds very little overhead in itself. Like any select-based backend its
…		…
2084	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2214	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2085	(1%) are active. This mirrors the activity of large servers with many	2215	(1%) are active. This mirrors the activity of large servers with many
2086	connections, most of which are idle at any one point in time.	2216	connections, most of which are idle at any one point in time.
2087		2217
2088	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2218	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2089	distribution.	2219	distribution. It uses the L<AE> interface, which makes a real difference
		2220	for the EV and Perl backends only.
2090		2221
2091	=head3 Explanation of the columns	2222	=head3 Explanation of the columns
2092		2223
2093	I<sockets> is the number of sockets, and twice the number of "servers" (as	2224	I<sockets> is the number of sockets, and twice the number of "servers" (as
2094	each server has a read and write socket end).	2225	each server has a read and write socket end).
…		…
2102	a new one that moves the timeout into the future.	2233	a new one that moves the timeout into the future.
2103		2234
2104	=head3 Results	2235	=head3 Results
2105		2236
2106	name sockets create request	2237	name sockets create request
2107	EV 20000 69.01 11.16	2238	EV 20000 62.66 7.99
2108	Perl 20000 73.32 35.87	2239	Perl 20000 68.32 32.64
2109	IOAsync 20000 157.00 98.14 epoll	2240	IOAsync 20000 174.06 101.15 epoll
2110	IOAsync 20000 159.31 616.06 poll	2241	IOAsync 20000 174.67 610.84 poll
2111	Event 20000 212.62 257.32	2242	Event 20000 202.69 242.91
2112	Glib 20000 651.16 1896.30	2243	Glib 20000 557.01 1689.52
2113	POE 20000 349.67 12317.24 uses POE::Loop::Event	2244	POE 20000 341.54 12086.32 uses POE::Loop::Event
2114		2245
2115	=head3 Discussion	2246	=head3 Discussion
2116		2247
2117	This benchmark I<does> measure scalability and overall performance of the	2248	This benchmark I<does> measure scalability and overall performance of the
2118	particular event loop.	2249	particular event loop.
…		…
2244	As you can see, the AnyEvent + EV combination even beats the	2375	As you can see, the AnyEvent + EV combination even beats the
2245	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2376	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2246	backend easily beats IO::Lambda and POE.	2377	backend easily beats IO::Lambda and POE.
2247		2378
2248	And even the 100% non-blocking version written using the high-level (and	2379	And even the 100% non-blocking version written using the high-level (and
2249	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2380	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2250	large margin, even though it does all of DNS, tcp-connect and socket I/O	2381	higher level ("unoptimised") abstractions by a large margin, even though
2251	in a non-blocking way.	2382	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2252		2383
2253	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2384	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2254	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2385	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2255	part of the IO::lambda distribution and were used without any changes.	2386	part of the IO::Lambda distribution and were used without any changes.
2256		2387
2257		2388
2258	=head1 SIGNALS	2389	=head1 SIGNALS
2259		2390
2260	AnyEvent currently installs handlers for these signals:	2391	AnyEvent currently installs handlers for these signals:
…		…
2349	lot less memory), but otherwise doesn't affect guard operation much. It is	2480	lot less memory), but otherwise doesn't affect guard operation much. It is
2350	purely used for performance.	2481	purely used for performance.
2351		2482
2352	=item L<JSON> and L<JSON::XS>	2483	=item L<JSON> and L<JSON::XS>
2353		2484
2354	This module is required when you want to read or write JSON data via	2485	One of these modules is required when you want to read or write JSON data
2355	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2486	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2356	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2487	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2357		2488
2358	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2489	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2359	installed.	2490	installed.
2360		2491

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.259 by root, Tue Jul 28 02:07:18 2009 UTC vs. Revision 1.296 by root, Tue Nov 17 01:19:49 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.259 by root, Tue Jul 28 02:07:18 2009 UTC vs.
Revision 1.296 by root, Tue Nov 17 01:19:49 2009 UTC