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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.257 by root, Sun Jul 26 00:17:25 2009 UTC vs.
Revision 1.282 by root, Tue Aug 11 01:18:27 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - the DBI of event loop programming	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, IO::Async, Qt and POE are	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	various supported event loops/environments.	6	and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
181	my variables are only visible after the statement in which they are	181	my variables are only visible after the statement in which they are
182	declared.	182	declared.
183		183
184	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
185		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
186	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	192	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
188		194
189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	195	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
190	for events (AnyEvent might or might not keep a reference to this file	196	for events (AnyEvent might or might not keep a reference to this file
…		…
219	undef $w;	225	undef $w;
220	});	226	});
221		227
222	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
223		229
		230	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		231
		232	$w = AnyEvent->timer (
		233	after => <fractional_seconds>,
		234	interval => <fractional_seconds>,
		235	cb => <callback>,
		236	);
		237
224	You can create a time watcher by calling the C<< AnyEvent->timer >>	238	You can create a time watcher by calling the C<< AnyEvent->timer >>
225	method with the following mandatory arguments:	239	method with the following mandatory arguments:
226		240
227	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
228	supported) the callback should be invoked. C<cb> is the callback to invoke	242	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
355		369
356	=back	370	=back
357		371
358	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
359		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		375
360	You can watch for signals using a signal watcher, C<signal> is the signal	376	You can watch for signals using a signal watcher, C<signal> is the signal
361	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	377	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
363		379
364	Although the callback might get passed parameters, their value and	380	Although the callback might get passed parameters, their value and
…		…
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		400
385	=head3 Signal Races, Delays and Workarounds	401	=head3 Signal Races, Delays and Workarounds
386		402
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388	callbacks to signals in a generic way, which is a pity, as you cannot do	404	callbacks to signals in a generic way, which is a pity, as you cannot
389	race-free signal handling in perl. AnyEvent will try to do it's best, but	405	do race-free signal handling in perl, requiring C libraries for
		406	this. AnyEvent will try to do it's best, which means in some cases,
390	in some cases, signals will be delayed. The maximum time a signal might	407	signals will be delayed. The maximum time a signal might be delayed is
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	409	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	410	and should be left alone otherwise. This variable determines how often
		411	AnyEvent polls for signals (in case a wake-up was missed). Higher values
394	will cause fewer spurious wake-ups, which is better for power and CPU	412	will cause fewer spurious wake-ups, which is better for power and CPU
		413	saving.
		414
395	saving. All these problems can be avoided by installing the optional	415	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	416	L<Async::Interrupt> module, which works with most event loops. It will not
397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	417	work with inherently broken event loops such as L<Event> or L<Event::Lib>
398	currently, as POE does it's own workaround with one-second latency). With	418	(and not with L<POE> currently, as POE does it's own workaround with
399	those, you just have to suffer the delays.	419	one-second latency). For those, you just have to suffer the delays.
400		420
401	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
402		424
403	You can also watch on a child process exit and catch its exit status.	425	You can also watch on a child process exit and catch its exit status.
404		426
405	The child process is specified by the C<pid> argument (one some backends,	427	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	428	using C<0> watches for any child process exit, on others this will
…		…
455	# do something else, then wait for process exit	477	# do something else, then wait for process exit
456	$done->recv;	478	$done->recv;
457		479
458	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
459		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
460	Sometimes there is a need to do something, but it is not so important	484	Sometimes there is a need to do something, but it is not so important
461	to do it instantly, but only when there is nothing better to do. This	485	to do it instantly, but only when there is nothing better to do. This
462	"nothing better to do" is usually defined to be "no other events need	486	"nothing better to do" is usually defined to be "no other events need
463	attention by the event loop".	487	attention by the event loop".
464		488
…		…
490	});	514	});
491	});	515	});
492		516
493	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
494		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
495	If you are familiar with some event loops you will know that all of them	524	If you are familiar with some event loops you will know that all of them
496	require you to run some blocking "loop", "run" or similar function that	525	require you to run some blocking "loop", "run" or similar function that
497	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
498		527
499	AnyEvent is slightly different: it expects somebody else to run the event	528	AnyEvent is slightly different: it expects somebody else to run the event
…		…
637	one. For example, a function that pings many hosts in parallel might want	666	one. For example, a function that pings many hosts in parallel might want
638	to use a condition variable for the whole process.	667	to use a condition variable for the whole process.
639		668
640	Every call to C<< ->begin >> will increment a counter, and every call to	669	Every call to C<< ->begin >> will increment a counter, and every call to
641	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
642	>>, the (last) callback passed to C<begin> will be executed. That callback	671	>>, the (last) callback passed to C<begin> will be executed, passing the
643	is I<supposed> to call C<< ->send >>, but that is not required. If no	672	condvar as first argument. That callback is I<supposed> to call C<< ->send
644	callback was set, C<send> will be called without any arguments.	673	>>, but that is not required. If no group callback was set, C<send> will
		674	be called without any arguments.
645		675
646	You can think of C<< $cv->send >> giving you an OR condition (one call	676	You can think of C<< $cv->send >> giving you an OR condition (one call
647	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	677	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
648	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	678	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
649		679
…		…
676	begung can potentially be zero:	706	begung can potentially be zero:
677		707
678	my $cv = AnyEvent->condvar;	708	my $cv = AnyEvent->condvar;
679		709
680	my %result;	710	my %result;
681	$cv->begin (sub { $cv->send (\%result) });	711	$cv->begin (sub { shift->send (\%result) });
682		712
683	for my $host (@list_of_hosts) {	713	for my $host (@list_of_hosts) {
684	$cv->begin;	714	$cv->begin;
685	ping_host_then_call_callback $host, sub {	715	ping_host_then_call_callback $host, sub {
686	$result{$host} = ...;	716	$result{$host} = ...;
…		…
761	=item $cb = $cv->cb ($cb->($cv))	791	=item $cb = $cv->cb ($cb->($cv))
762		792
763	This is a mutator function that returns the callback set and optionally	793	This is a mutator function that returns the callback set and optionally
764	replaces it before doing so.	794	replaces it before doing so.
765		795
766	The callback will be called when the condition becomes "true", i.e. when	796	The callback will be called when the condition becomes (or already was)
767	C<send> or C<croak> are called, with the only argument being the condition	797	"true", i.e. when C<send> or C<croak> are called (or were called), with
768	variable itself. Calling C<recv> inside the callback or at any later time	798	the only argument being the condition variable itself. Calling C<recv>
769	is guaranteed not to block.	799	inside the callback or at any later time is guaranteed not to block.
770		800
771	=back	801	=back
772		802
773	=head1 SUPPORTED EVENT LOOPS/BACKENDS	803	=head1 SUPPORTED EVENT LOOPS/BACKENDS
774		804
…		…
777	=over 4	807	=over 4
778		808
779	=item Backends that are autoprobed when no other event loop can be found.	809	=item Backends that are autoprobed when no other event loop can be found.
780		810
781	EV is the preferred backend when no other event loop seems to be in	811	EV is the preferred backend when no other event loop seems to be in
782	use. If EV is not installed, then AnyEvent will try Event, and, failing	812	use. If EV is not installed, then AnyEvent will fall back to its own
783	that, will fall back to its own pure-perl implementation, which is	813	pure-perl implementation, which is available everywhere as it comes with
784	available everywhere as it comes with AnyEvent itself.	814	AnyEvent itself.
785		815
786	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	816	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.	817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789		818
790	=item Backends that are transparently being picked up when they are used.	819	=item Backends that are transparently being picked up when they are used.
791		820
792	These will be used when they are currently loaded when the first watcher	821	These will be used when they are currently loaded when the first watcher
793	is created, in which case it is assumed that the application is using	822	is created, in which case it is assumed that the application is using
794	them. This means that AnyEvent will automatically pick the right backend	823	them. This means that AnyEvent will automatically pick the right backend
795	when the main program loads an event module before anything starts to	824	when the main program loads an event module before anything starts to
796	create watchers. Nothing special needs to be done by the main program.	825	create watchers. Nothing special needs to be done by the main program.
797		826
		827	AnyEvent::Impl::Event based on Event, very stable, few glitches.
798	AnyEvent::Impl::Glib based on Glib, slow but very stable.	828	AnyEvent::Impl::Glib based on Glib, slow but very stable.
799	AnyEvent::Impl::Tk based on Tk, very broken.	829	AnyEvent::Impl::Tk based on Tk, very broken.
800	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	830	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801	AnyEvent::Impl::POE based on POE, very slow, some limitations.	831	AnyEvent::Impl::POE based on POE, very slow, some limitations.
802	AnyEvent::Impl::Irssi used when running within irssi.	832	AnyEvent::Impl::Irssi used when running within irssi.
…		…
1086		1116
1087	BEGIN { AnyEvent::common_sense }	1117	BEGIN { AnyEvent::common_sense }
1088		1118
1089	use Carp ();	1119	use Carp ();
1090		1120
1091	our $VERSION = 4.87;	1121	our $VERSION = '5.1';
1092	our $MODEL;	1122	our $MODEL;
1093		1123
1094	our $AUTOLOAD;	1124	our $AUTOLOAD;
1095	our @ISA;	1125	our @ISA;
1096		1126
…		…
1122	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1152	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1123	}	1153	}
1124		1154
1125	my @models = (	1155	my @models = (
1126	[EV:: => AnyEvent::Impl::EV:: , 1],	1156	[EV:: => AnyEvent::Impl::EV:: , 1],
1127	[Event:: => AnyEvent::Impl::Event::, 1],
1128	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129	# everything below here will not (normally) be autoprobed	1158	# everything below here will not (normally) be autoprobed
1130	# as the pureperl backend should work everywhere	1159	# as the pureperl backend should work everywhere
1131	# and is usually faster	1160	# and is usually faster
		1161	[Event:: => AnyEvent::Impl::Event::, 1],
1132	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1162	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1163	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1164	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1165	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1166	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1139	[Prima:: => AnyEvent::Impl::POE::],	1169	[Prima:: => AnyEvent::Impl::POE::],
1140	# IO::Async is just too broken - we would need workarounds for its	1170	# IO::Async is just too broken - we would need workarounds for its
1141	# byzantine signal and broken child handling, among others.	1171	# byzantine signal and broken child handling, among others.
1142	# IO::Async is rather hard to detect, as it doesn't have any	1172	# IO::Async is rather hard to detect, as it doesn't have any
1143	# obvious default class.	1173	# obvious default class.
1144	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1176	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1177	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147	);	1178	);
1148		1179
1149	our %method = map +($_ => 1),	1180	our %method = map +($_ => 1),
1150	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1181	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151		1182
…		…
1258	# we assume CLOEXEC is already set by perl in all important cases	1289	# we assume CLOEXEC is already set by perl in all important cases
1259		1290
1260	($fh2, $rw)	1291	($fh2, $rw)
1261	}	1292	}
1262		1293
		1294	=head1 SIMPLIFIED AE API
		1295
		1296	Starting with version 5.0, AnyEvent officially supports a second, much
		1297	simpler, API that is designed to reduce the calling, typing and memory
		1298	overhead.
		1299
		1300	See the L<AE> manpage for details.
		1301
		1302	=cut
		1303
		1304	package AE;
		1305
		1306	our $VERSION = $AnyEvent::VERSION;
		1307
		1308	sub io($$$) {
		1309	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1310	}
		1311
		1312	sub timer($$$) {
		1313	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1314	}
		1315
		1316	sub signal($$) {
		1317	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1318	}
		1319
		1320	sub child($$) {
		1321	AnyEvent->child (pid => $_[0], cb => $_[1])
		1322	}
		1323
		1324	sub idle($) {
		1325	AnyEvent->idle (cb => $_[0])
		1326	}
		1327
		1328	sub cv(;&) {
		1329	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1330	}
		1331
		1332	sub now() {
		1333	AnyEvent->now
		1334	}
		1335
		1336	sub now_update() {
		1337	AnyEvent->now_update
		1338	}
		1339
		1340	sub time() {
		1341	AnyEvent->time
		1342	}
		1343
1263	package AnyEvent::Base;	1344	package AnyEvent::Base;
1264		1345
1265	# default implementations for many methods	1346	# default implementations for many methods
1266		1347
1267	sub _time {	1348	sub _time {
…		…
1289	}	1370	}
1290		1371
1291	# default implementation for ->signal	1372	# default implementation for ->signal
1292		1373
1293	our $HAVE_ASYNC_INTERRUPT;	1374	our $HAVE_ASYNC_INTERRUPT;
		1375
		1376	sub _have_async_interrupt() {
		1377	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1378	&& eval "use Async::Interrupt 1.0 (); 1")
		1379	unless defined $HAVE_ASYNC_INTERRUPT;
		1380
		1381	$HAVE_ASYNC_INTERRUPT
		1382	}
		1383
1294	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1384	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1295	our (%SIG_ASY, %SIG_ASY_W);	1385	our (%SIG_ASY, %SIG_ASY_W);
1296	our ($SIG_COUNT, $SIG_TW);	1386	our ($SIG_COUNT, $SIG_TW);
1297		1387
1298	sub _signal_exec {	1388	sub _signal_exec {
…		…
1306	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1396	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1307	}	1397	}
1308	}	1398	}
1309	}	1399	}
1310		1400
1311	# install a dumym wakeupw atcher to reduce signal catching latency	1401	# install a dummy wakeup watcher to reduce signal catching latency
1312	sub _sig_add() {	1402	sub _sig_add() {
1313	unless ($SIG_COUNT++) {	1403	unless ($SIG_COUNT++) {
1314	# try to align timer on a full-second boundary, if possible	1404	# try to align timer on a full-second boundary, if possible
1315	my $NOW = AnyEvent->now;	1405	my $NOW = AE::now;
1316		1406
1317	$SIG_TW = AnyEvent->timer (	1407	$SIG_TW = AE::timer
1318	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1408	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1319	interval => $MAX_SIGNAL_LATENCY,	1409	$MAX_SIGNAL_LATENCY,
1320	cb => sub { }, # just for the PERL_ASYNC_CHECK	1410	sub { } # just for the PERL_ASYNC_CHECK
1321	);	1411	;
1322	}	1412	}
1323	}	1413	}
1324		1414
1325	sub _sig_del {	1415	sub _sig_del {
1326	undef $SIG_TW	1416	undef $SIG_TW
1327	unless --$SIG_COUNT;	1417	unless --$SIG_COUNT;
1328	}	1418	}
1329		1419
		1420	our $_sig_name_init; $_sig_name_init = sub {
		1421	eval q{ # poor man's autoloading
		1422	undef $_sig_name_init;
		1423
		1424	if (_have_async_interrupt) {
		1425	*sig2num = \&Async::Interrupt::sig2num;
		1426	*sig2name = \&Async::Interrupt::sig2name;
		1427	} else {
		1428	require Config;
		1429
		1430	my %signame2num;
		1431	@signame2num{ split ' ', $Config::Config{sig_name} }
		1432	= split ' ', $Config::Config{sig_num};
		1433
		1434	my @signum2name;
		1435	@signum2name[values %signame2num] = keys %signame2num;
		1436
		1437	*sig2num = sub($) {
		1438	$_[0] > 0 ? shift : $signame2num{+shift}
		1439	};
		1440	*sig2name = sub ($) {
		1441	$_[0] > 0 ? $signum2name[+shift] : shift
		1442	};
		1443	}
		1444	};
		1445	die if $@;
		1446	};
		1447
		1448	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1449	sub sig2name($) { &$_sig_name_init; &sig2name }
		1450
1330	sub _signal {	1451	sub signal {
		1452	eval q{ # poor man's autoloading {}
		1453	# probe for availability of Async::Interrupt
		1454	if (_have_async_interrupt) {
		1455	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1456
		1457	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1458	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1459
		1460	} else {
		1461	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1462
		1463	require Fcntl;
		1464
		1465	if (AnyEvent::WIN32) {
		1466	require AnyEvent::Util;
		1467
		1468	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1470	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1471	} else {
		1472	pipe $SIGPIPE_R, $SIGPIPE_W;
		1473	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1474	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1475
		1476	# not strictly required, as $^F is normally 2, but let's make sure...
		1477	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1478	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1479	}
		1480
		1481	$SIGPIPE_R
		1482	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1483
		1484	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1485	}
		1486
		1487	*signal = sub {
1331	my (undef, %arg) = @_;	1488	my (undef, %arg) = @_;
1332		1489
1333	my $signal = uc $arg{signal}	1490	my $signal = uc $arg{signal}
1334	or Carp::croak "required option 'signal' is missing";	1491	or Carp::croak "required option 'signal' is missing";
1335		1492
1336	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1337
1338	if ($HAVE_ASYNC_INTERRUPT) {	1493	if ($HAVE_ASYNC_INTERRUPT) {
1339	# async::interrupt	1494	# async::interrupt
1340		1495
1341	$SIG_ASY{$signal} \|\|= do {	1496	$signal = sig2num $signal;
1342	my $asy = new Async::Interrupt	1497	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1498
		1499	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1343	cb => sub { undef $SIG_EV{$signal} },	1500	cb => sub { undef $SIG_EV{$signal} },
1344	signal => $signal,	1501	signal => $signal,
1345	pipe => [$SIGPIPE_R->filenos],	1502	pipe => [$SIGPIPE_R->filenos],
		1503	pipe_autodrain => 0,
		1504	;
		1505
		1506	} else {
		1507	# pure perl
		1508
		1509	# AE::Util has been loaded in signal
		1510	$signal = sig2name $signal;
		1511	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1512
		1513	$SIG{$signal} \|\|= sub {
		1514	local $!;
		1515	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1516	undef $SIG_EV{$signal};
		1517	};
		1518
		1519	# can't do signal processing without introducing races in pure perl,
		1520	# so limit the signal latency.
		1521	_sig_add;
1346	;	1522	}
1347	$asy->pipe_autodrain (0);
1348		1523
1349	$asy	1524	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1350	};	1525	};
1351		1526
1352	} else {	1527	*AnyEvent::Base::signal::DESTROY = sub {
1353	# pure perl	1528	my ($signal, $cb) = @{$_[0]};
1354		1529
1355	$SIG{$signal} \|\|= sub {	1530	_sig_del;
1356	local $!;	1531
1357	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1532	delete $SIG_CB{$signal}{$cb};
		1533
		1534	$HAVE_ASYNC_INTERRUPT
		1535	? delete $SIG_ASY{$signal}
		1536	: # delete doesn't work with older perls - they then
		1537	# print weird messages, or just unconditionally exit
		1538	# instead of getting the default action.
1358	undef $SIG_EV{$signal};	1539	undef $SIG{$signal}
		1540	unless keys %{ $SIG_CB{$signal} };
1359	};	1541	};
1360
1361	# can't do signal processing without introducing races in pure perl,
1362	# so limit the signal latency.
1363	_sig_add;
1364	}	1542	};
1365		1543	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	1544	&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	}	1545	}
1424		1546
1425	# default implementation for ->child	1547	# default implementation for ->child
1426		1548
1427	our %PID_CB;	1549	our %PID_CB;
…		…
1456	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1578	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1457	? 1	1579	? 1
1458	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1580	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1459		1581
1460	unless ($CHLD_W) {	1582	unless ($CHLD_W) {
1461	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1583	$CHLD_W = AE::signal CHLD => \&_sigchld;
1462	# child could be a zombie already, so make at least one round	1584	# child could be a zombie already, so make at least one round
1463	&_sigchld;	1585	&_sigchld;
1464	}	1586	}
1465		1587
1466	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1588	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1492	# never use more then 50% of the time for the idle watcher,	1614	# never use more then 50% of the time for the idle watcher,
1493	# within some limits	1615	# within some limits
1494	$w = 0.0001 if $w < 0.0001;	1616	$w = 0.0001 if $w < 0.0001;
1495	$w = 5 if $w > 5;	1617	$w = 5 if $w > 5;
1496		1618
1497	$w = AnyEvent->timer (after => $w, cb => $rcb);	1619	$w = AE::timer $w, 0, $rcb;
1498	} else {	1620	} else {
1499	# clean up...	1621	# clean up...
1500	undef $w;	1622	undef $w;
1501	undef $rcb;	1623	undef $rcb;
1502	}	1624	}
1503	};	1625	};
1504		1626
1505	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1627	$w = AE::timer 0.05, 0, $rcb;
1506		1628
1507	bless \\$cb, "AnyEvent::Base::idle"	1629	bless \\$cb, "AnyEvent::Base::idle"
1508	}	1630	}
1509		1631
1510	sub AnyEvent::Base::idle::DESTROY {	1632	sub AnyEvent::Base::idle::DESTROY {
…		…
1564	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1686	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1565	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1687	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1566	}	1688	}
1567		1689
1568	sub cb {	1690	sub cb {
1569	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1691	my $cv = shift;
		1692
		1693	@_
		1694	and $cv->{_ae_cb} = shift
		1695	and $cv->{_ae_sent}
		1696	and (delete $cv->{_ae_cb})->($cv);
		1697
1570	$_[0]{_ae_cb}	1698	$cv->{_ae_cb}
1571	}	1699	}
1572		1700
1573	sub begin {	1701	sub begin {
1574	++$_[0]{_ae_counter};	1702	++$_[0]{_ae_counter};
1575	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1703	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
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.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.257 by root, Sun Jul 26 00:17:25 2009 UTC vs. Revision 1.282 by root, Tue Aug 11 01:18:27 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.257 by root, Sun Jul 26 00:17:25 2009 UTC vs.
Revision 1.282 by root, Tue Aug 11 01:18:27 2009 UTC