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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.250 by root, Mon Jul 20 07:12:38 2009 UTC vs.
Revision 1.278 by root, Sun Aug 9 15:09:28 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - events independent of event loop implementation	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	event loops.	6	and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
47		47
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	48	There is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	49	channel, too.
50		50
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Respository>, at L<http://anyevent.schmorp.de>, for more info.	52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		53
54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55		55
56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
57	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
181	my variables are only visible after the statement in which they are	181	my variables are only visible after the statement in which they are
182	declared.	182	declared.
183		183
184	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
185		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
186	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	192	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
188		194
189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	195	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
190	for events (AnyEvent might or might not keep a reference to this file	196	for events (AnyEvent might or might not keep a reference to this file
…		…
219	undef $w;	225	undef $w;
220	});	226	});
221		227
222	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
223		229
		230	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		231
		232	$w = AnyEvent->timer (
		233	after => <fractional_seconds>,
		234	interval => <fractional_seconds>,
		235	cb => <callback>,
		236	);
		237
224	You can create a time watcher by calling the C<< AnyEvent->timer >>	238	You can create a time watcher by calling the C<< AnyEvent->timer >>
225	method with the following mandatory arguments:	239	method with the following mandatory arguments:
226		240
227	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
228	supported) the callback should be invoked. C<cb> is the callback to invoke	242	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
355		369
356	=back	370	=back
357		371
358	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
359		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		375
360	You can watch for signals using a signal watcher, C<signal> is the signal	376	You can watch for signals using a signal watcher, C<signal> is the signal
361	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	377	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
363		379
364	Although the callback might get passed parameters, their value and	380	Although the callback might get passed parameters, their value and
…		…
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		400
385	=head3 Signal Races, Delays and Workarounds	401	=head3 Signal Races, Delays and Workarounds
386		402
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388	callbacks to signals in a generic way, which is a pity, as you cannot do	404	callbacks to signals in a generic way, which is a pity, as you cannot
389	race-free signal handling in perl. AnyEvent will try to do it's best, but	405	do race-free signal handling in perl, requiring C libraries for
		406	this. AnyEvent will try to do it's best, which means in some cases,
390	in some cases, signals will be delayed. The maximum time a signal might	407	signals will be delayed. The maximum time a signal might be delayed is
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	409	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	410	and should be left alone otherwise. This variable determines how often
		411	AnyEvent polls for signals (in case a wake-up was missed). Higher values
394	will cause fewer spurious wake-ups, which is better for power and CPU	412	will cause fewer spurious wake-ups, which is better for power and CPU
		413	saving.
		414
395	saving. All these problems can be avoided by installing the optional	415	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	416	L<Async::Interrupt> module, which works with most event loops. It will not
397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	417	work with inherently broken event loops such as L<Event> or L<Event::Lib>
398	currently, as POE does it's own workaround with one-second latency). With	418	(and not with L<POE> currently, as POE does it's own workaround with
399	those, you just have to suffer the delays.	419	one-second latency). For those, you just have to suffer the delays.
400		420
401	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
402		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
403	You can also watch on a child process exit and catch its exit status.	425	You can also watch on a child process exit and catch its exit status.
404		426
405	The child process is specified by the C<pid> argument (if set to C<0>, it	427	The child process is specified by the C<pid> argument (one some backends,
406	watches for any child process exit). The watcher will triggered only when	428	using C<0> watches for any child process exit, on others this will
407	the child process has finished and an exit status is available, not on	429	croak). The watcher will be triggered only when the child process has
408	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
409		432
410	The callback will be called with the pid and exit status (as returned by	433	The callback will be called with the pid and exit status (as returned by
411	waitpid), so unlike other watcher types, you I<can> rely on child watcher	434	waitpid), so unlike other watcher types, you I<can> rely on child watcher
412	callback arguments.	435	callback arguments.
413		436
…		…
454	# do something else, then wait for process exit	477	# do something else, then wait for process exit
455	$done->recv;	478	$done->recv;
456		479
457	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
458		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
459	Sometimes there is a need to do something, but it is not so important	484	Sometimes there is a need to do something, but it is not so important
460	to do it instantly, but only when there is nothing better to do. This	485	to do it instantly, but only when there is nothing better to do. This
461	"nothing better to do" is usually defined to be "no other events need	486	"nothing better to do" is usually defined to be "no other events need
462	attention by the event loop".	487	attention by the event loop".
463		488
…		…
489	});	514	});
490	});	515	});
491		516
492	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
493		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
494	If you are familiar with some event loops you will know that all of them	524	If you are familiar with some event loops you will know that all of them
495	require you to run some blocking "loop", "run" or similar function that	525	require you to run some blocking "loop", "run" or similar function that
496	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
497		527
498	AnyEvent is slightly different: it expects somebody else to run the event	528	AnyEvent is slightly different: it expects somebody else to run the event
…		…
760	=item $cb = $cv->cb ($cb->($cv))	790	=item $cb = $cv->cb ($cb->($cv))
761		791
762	This is a mutator function that returns the callback set and optionally	792	This is a mutator function that returns the callback set and optionally
763	replaces it before doing so.	793	replaces it before doing so.
764		794
765	The callback will be called when the condition becomes "true", i.e. when	795	The callback will be called when the condition becomes (or already was)
766	C<send> or C<croak> are called, with the only argument being the condition	796	"true", i.e. when C<send> or C<croak> are called (or were called), with
767	variable itself. Calling C<recv> inside the callback or at any later time	797	the only argument being the condition variable itself. Calling C<recv>
768	is guaranteed not to block.	798	inside the callback or at any later time is guaranteed not to block.
769		799
770	=back	800	=back
771		801
772	=head1 SUPPORTED EVENT LOOPS/BACKENDS	802	=head1 SUPPORTED EVENT LOOPS/BACKENDS
773		803
…		…
776	=over 4	806	=over 4
777		807
778	=item Backends that are autoprobed when no other event loop can be found.	808	=item Backends that are autoprobed when no other event loop can be found.
779		809
780	EV is the preferred backend when no other event loop seems to be in	810	EV is the preferred backend when no other event loop seems to be in
781	use. If EV is not installed, then AnyEvent will try Event, and, failing	811	use. If EV is not installed, then AnyEvent will fall back to its own
782	that, will fall back to its own pure-perl implementation, which is	812	pure-perl implementation, which is available everywhere as it comes with
783	available everywhere as it comes with AnyEvent itself.	813	AnyEvent itself.
784		814
785	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
786	AnyEvent::Impl::Event based on Event, very stable, few glitches.
787	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	816	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
788		817
789	=item Backends that are transparently being picked up when they are used.	818	=item Backends that are transparently being picked up when they are used.
790		819
791	These will be used when they are currently loaded when the first watcher	820	These will be used when they are currently loaded when the first watcher
792	is created, in which case it is assumed that the application is using	821	is created, in which case it is assumed that the application is using
793	them. This means that AnyEvent will automatically pick the right backend	822	them. This means that AnyEvent will automatically pick the right backend
794	when the main program loads an event module before anything starts to	823	when the main program loads an event module before anything starts to
795	create watchers. Nothing special needs to be done by the main program.	824	create watchers. Nothing special needs to be done by the main program.
796		825
		826	AnyEvent::Impl::Event based on Event, very stable, few glitches.
797	AnyEvent::Impl::Glib based on Glib, slow but very stable.	827	AnyEvent::Impl::Glib based on Glib, slow but very stable.
798	AnyEvent::Impl::Tk based on Tk, very broken.	828	AnyEvent::Impl::Tk based on Tk, very broken.
799	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
800	AnyEvent::Impl::POE based on POE, very slow, some limitations.	830	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		831	AnyEvent::Impl::Irssi used when running within irssi.
801		832
802	=item Backends with special needs.	833	=item Backends with special needs.
803		834
804	Qt requires the Qt::Application to be instantiated first, but will	835	Qt requires the Qt::Application to be instantiated first, but will
805	otherwise be picked up automatically. As long as the main program	836	otherwise be picked up automatically. As long as the main program
…		…
879	event module detection too early, for example, L<AnyEvent::AIO> creates	910	event module detection too early, for example, L<AnyEvent::AIO> creates
880	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	911	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
881	avoid autodetecting the event module at load time.	912	avoid autodetecting the event module at load time.
882		913
883	If called in scalar or list context, then it creates and returns an object	914	If called in scalar or list context, then it creates and returns an object
884	that automatically removes the callback again when it is destroyed. See	915	that automatically removes the callback again when it is destroyed (or
		916	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
885	L<Coro::BDB> for a case where this is useful.	917	a case where this is useful.
		918
		919	Example: Create a watcher for the IO::AIO module and store it in
		920	C<$WATCHER>. Only do so after the event loop is initialised, though.
		921
		922	our WATCHER;
		923
		924	my $guard = AnyEvent::post_detect {
		925	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		926	};
		927
		928	# the \|\|= is important in case post_detect immediately runs the block,
		929	# as to not clobber the newly-created watcher. assigning both watcher and
		930	# post_detect guard to the same variable has the advantage of users being
		931	# able to just C<undef $WATCHER> if the watcher causes them grief.
		932
		933	$WATCHER \|\|= $guard;
886		934
887	=item @AnyEvent::post_detect	935	=item @AnyEvent::post_detect
888		936
889	If there are any code references in this array (you can C<push> to it	937	If there are any code references in this array (you can C<push> to it
890	before or after loading AnyEvent), then they will called directly after	938	before or after loading AnyEvent), then they will called directly after
…		…
1067		1115
1068	BEGIN { AnyEvent::common_sense }	1116	BEGIN { AnyEvent::common_sense }
1069		1117
1070	use Carp ();	1118	use Carp ();
1071		1119
1072	our $VERSION = 4.85;	1120	our $VERSION = 4.92;
1073	our $MODEL;	1121	our $MODEL;
1074		1122
1075	our $AUTOLOAD;	1123	our $AUTOLOAD;
1076	our @ISA;	1124	our @ISA;
1077		1125
…		…
1102	for reverse split /\s,\s/,	1150	for reverse split /\s,\s/,
1103	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1104	}	1152	}
1105		1153
1106	my @models = (	1154	my @models = (
1107	[EV:: => AnyEvent::Impl::EV::],	1155	[EV:: => AnyEvent::Impl::EV:: , 1],
1108	[Event:: => AnyEvent::Impl::Event::],
1109	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1156	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1110	# everything below here will not be autoprobed	1157	# everything below here will not (normally) be autoprobed
1111	# as the pureperl backend should work everywhere	1158	# as the pureperl backend should work everywhere
1112	# and is usually faster	1159	# and is usually faster
		1160	[Event:: => AnyEvent::Impl::Event::, 1],
1113	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1114	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1115	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1116	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1117	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1118	[Wx:: => AnyEvent::Impl::POE::],	1167	[Wx:: => AnyEvent::Impl::POE::],
1119	[Prima:: => AnyEvent::Impl::POE::],	1168	[Prima:: => AnyEvent::Impl::POE::],
1120	# IO::Async is just too broken - we would need workarounds for its	1169	# IO::Async is just too broken - we would need workarounds for its
1121	# byzantine signal and broken child handling, among others.	1170	# byzantine signal and broken child handling, among others.
1122	# IO::Async is rather hard to detect, as it doesn't have any	1171	# IO::Async is rather hard to detect, as it doesn't have any
1123	# obvious default class.	1172	# obvious default class.
1124	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1173	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1126	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1176	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1127	);	1177	);
1128		1178
1129	our %method = map +($_ => 1),	1179	our %method = map +($_ => 1),
1130	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1180	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1131		1181
…		…
1135	my ($cb) = @_;	1185	my ($cb) = @_;
1136		1186
1137	if ($MODEL) {	1187	if ($MODEL) {
1138	$cb->();	1188	$cb->();
1139		1189
1140	1	1190	undef
1141	} else {	1191	} else {
1142	push @post_detect, $cb;	1192	push @post_detect, $cb;
1143		1193
1144	defined wantarray	1194	defined wantarray
1145	? bless \$cb, "AnyEvent::Util::postdetect"	1195	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1177	}	1227	}
1178	}	1228	}
1179	}	1229	}
1180		1230
1181	unless ($MODEL) {	1231	unless ($MODEL) {
1182	# try to load a model	1232	# try to autoload a model
1183
1184	for (@REGISTRY, @models) {	1233	for (@REGISTRY, @models) {
1185	my ($package, $model) = @$_;	1234	my ($package, $model, $autoload) = @$_;
		1235	if (
		1236	$autoload
1186	if (eval "require $package"	1237	and eval "require $package"
1187	and ${"$package\::VERSION"} > 0	1238	and ${"$package\::VERSION"} > 0
1188	and eval "require $model") {	1239	and eval "require $model"
		1240	) {
1189	$MODEL = $model;	1241	$MODEL = $model;
1190	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1242	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1191	last;	1243	last;
1192	}	1244	}
1193	}	1245	}
1194		1246
1195	$MODEL	1247	$MODEL
…		…
1234	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";	1286	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1235		1287
1236	# we assume CLOEXEC is already set by perl in all important cases	1288	# we assume CLOEXEC is already set by perl in all important cases
1237		1289
1238	($fh2, $rw)	1290	($fh2, $rw)
		1291	}
		1292
		1293	=head1 SIMPLIFIED AE API
		1294
		1295	Starting with version 5.0, AnyEvent officially supports a second, much
		1296	simpler, API that is designed to reduce the calling, typing and memory
		1297	overhead.
		1298
		1299	See the L<AE> manpage for details.
		1300
		1301	=cut
		1302
		1303	package AE;
		1304
		1305	our $VERSION = $AnyEvent::VERSION;
		1306
		1307	sub io($$$) {
		1308	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1309	}
		1310
		1311	sub timer($$$) {
		1312	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1313	}
		1314
		1315	sub signal($$) {
		1316	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1317	}
		1318
		1319	sub child($$) {
		1320	AnyEvent->child (pid => $_[0], cb => $_[1])
		1321	}
		1322
		1323	sub idle($) {
		1324	AnyEvent->idle (cb => $_[0])
		1325	}
		1326
		1327	sub cv(;&) {
		1328	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1329	}
		1330
		1331	sub now() {
		1332	AnyEvent->now
		1333	}
		1334
		1335	sub now_update() {
		1336	AnyEvent->now_update
		1337	}
		1338
		1339	sub time() {
		1340	AnyEvent->time
1239	}	1341	}
1240		1342
1241	package AnyEvent::Base;	1343	package AnyEvent::Base;
1242		1344
1243	# default implementations for many methods	1345	# default implementations for many methods
…		…
1267	}	1369	}
1268		1370
1269	# default implementation for ->signal	1371	# default implementation for ->signal
1270		1372
1271	our $HAVE_ASYNC_INTERRUPT;	1373	our $HAVE_ASYNC_INTERRUPT;
		1374
		1375	sub _have_async_interrupt() {
		1376	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1377	&& eval "use Async::Interrupt 1.0 (); 1")
		1378	unless defined $HAVE_ASYNC_INTERRUPT;
		1379
		1380	$HAVE_ASYNC_INTERRUPT
		1381	}
		1382
1272	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1383	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1273	our (%SIG_ASY, %SIG_ASY_W);	1384	our (%SIG_ASY, %SIG_ASY_W);
1274	our ($SIG_COUNT, $SIG_TW);	1385	our ($SIG_COUNT, $SIG_TW);
1275		1386
1276	sub _signal_exec {	1387	sub _signal_exec {
…		…
1284	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1395	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1285	}	1396	}
1286	}	1397	}
1287	}	1398	}
1288		1399
1289	# install a dumym wakeupw atcher to reduce signal catching latency	1400	# install a dummy wakeup watcher to reduce signal catching latency
1290	sub _sig_add() {	1401	sub _sig_add() {
1291	unless ($SIG_COUNT++) {	1402	unless ($SIG_COUNT++) {
1292	# try to align timer on a full-second boundary, if possible	1403	# try to align timer on a full-second boundary, if possible
1293	my $NOW = AnyEvent->now;	1404	my $NOW = AE::now;
1294		1405
1295	$SIG_TW = AnyEvent->timer (	1406	$SIG_TW = AE::timer
1296	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1407	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1297	interval => $MAX_SIGNAL_LATENCY,	1408	$MAX_SIGNAL_LATENCY,
1298	cb => sub { }, # just for the PERL_ASYNC_CHECK	1409	sub { } # just for the PERL_ASYNC_CHECK
1299	);	1410	;
1300	}	1411	}
1301	}	1412	}
1302		1413
1303	sub _sig_del {	1414	sub _sig_del {
1304	undef $SIG_TW	1415	undef $SIG_TW
1305	unless --$SIG_COUNT;	1416	unless --$SIG_COUNT;
1306	}	1417	}
1307		1418
		1419	our $_sig_name_init; $_sig_name_init = sub {
		1420	eval q{ # poor man's autoloading
		1421	undef $_sig_name_init;
		1422
		1423	if (_have_async_interrupt) {
		1424	*sig2num = \&Async::Interrupt::sig2num;
		1425	*sig2name = \&Async::Interrupt::sig2name;
		1426	} else {
		1427	require Config;
		1428
		1429	my %signame2num;
		1430	@signame2num{ split ' ', $Config::Config{sig_name} }
		1431	= split ' ', $Config::Config{sig_num};
		1432
		1433	my @signum2name;
		1434	@signum2name[values %signame2num] = keys %signame2num;
		1435
		1436	*sig2num = sub($) {
		1437	$_[0] > 0 ? shift : $signame2num{+shift}
		1438	};
		1439	*sig2name = sub ($) {
		1440	$_[0] > 0 ? $signum2name[+shift] : shift
		1441	};
		1442	}
		1443	};
		1444	die if $@;
		1445	};
		1446
		1447	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1448	sub sig2name($) { &$_sig_name_init; &sig2name }
		1449
1308	sub _signal {	1450	sub signal {
		1451	eval q{ # poor man's autoloading {}
		1452	# probe for availability of Async::Interrupt
		1453	if (_have_async_interrupt) {
		1454	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1455
		1456	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1457	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1458
		1459	} else {
		1460	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1461
		1462	require Fcntl;
		1463
		1464	if (AnyEvent::WIN32) {
		1465	require AnyEvent::Util;
		1466
		1467	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1468	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1470	} else {
		1471	pipe $SIGPIPE_R, $SIGPIPE_W;
		1472	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1473	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1474
		1475	# not strictly required, as $^F is normally 2, but let's make sure...
		1476	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1477	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1478	}
		1479
		1480	$SIGPIPE_R
		1481	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1482
		1483	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1484	}
		1485
		1486	*signal = sub {
1309	my (undef, %arg) = @_;	1487	my (undef, %arg) = @_;
1310		1488
1311	my $signal = uc $arg{signal}	1489	my $signal = uc $arg{signal}
1312	or Carp::croak "required option 'signal' is missing";	1490	or Carp::croak "required option 'signal' is missing";
1313		1491
1314	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1315
1316	if ($HAVE_ASYNC_INTERRUPT) {	1492	if ($HAVE_ASYNC_INTERRUPT) {
1317	# async::interrupt	1493	# async::interrupt
1318		1494
1319	$SIG_ASY{$signal} \|\|= do {	1495	$signal = sig2num $signal;
1320	my $asy = new Async::Interrupt	1496	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1497
		1498	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1321	cb => sub { undef $SIG_EV{$signal} },	1499	cb => sub { undef $SIG_EV{$signal} },
1322	signal => $signal,	1500	signal => $signal,
1323	pipe => [$SIGPIPE_R->filenos],	1501	pipe => [$SIGPIPE_R->filenos],
		1502	pipe_autodrain => 0,
		1503	;
		1504
		1505	} else {
		1506	# pure perl
		1507
		1508	# AE::Util has been loaded in signal
		1509	$signal = sig2name $signal;
		1510	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1511
		1512	$SIG{$signal} \|\|= sub {
		1513	local $!;
		1514	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1515	undef $SIG_EV{$signal};
		1516	};
		1517
		1518	# can't do signal processing without introducing races in pure perl,
		1519	# so limit the signal latency.
		1520	_sig_add;
1324	;	1521	}
1325	$asy->pipe_autodrain (0);
1326		1522
1327	$asy	1523	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1328	};	1524	};
1329		1525
1330	} else {	1526	*AnyEvent::Base::signal::DESTROY = sub {
1331	# pure perl	1527	my ($signal, $cb) = @{$_[0]};
1332		1528
1333	$SIG{$signal} \|\|= sub {	1529	_sig_del;
1334	local $!;	1530
1335	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1531	delete $SIG_CB{$signal}{$cb};
		1532
		1533	$HAVE_ASYNC_INTERRUPT
		1534	? delete $SIG_ASY{$signal}
		1535	: # delete doesn't work with older perls - they then
		1536	# print weird messages, or just unconditionally exit
		1537	# instead of getting the default action.
1336	undef $SIG_EV{$signal};	1538	undef $SIG{$signal}
		1539	unless keys %{ $SIG_CB{$signal} };
1337	};	1540	};
1338
1339	# can't do signal processing without introducing races in pure perl,
1340	# so limit the signal latency.
1341	_sig_add;
1342	}	1541	};
1343		1542	die if $@;
1344	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1345	}
1346
1347	sub signal {
1348	# probe for availability of Async::Interrupt
1349	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1350	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1351
1352	$HAVE_ASYNC_INTERRUPT = 1;
1353	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1354	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1355
1356	} else {
1357	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1358
1359	require Fcntl;
1360
1361	if (AnyEvent::WIN32) {
1362	require AnyEvent::Util;
1363
1364	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1365	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1366	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1367	} else {
1368	pipe $SIGPIPE_R, $SIGPIPE_W;
1369	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1370	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1371
1372	# not strictly required, as $^F is normally 2, but let's make sure...
1373	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1375	}
1376
1377	$SIGPIPE_R
1378	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1379
1380	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1381	}
1382
1383	*signal = \&_signal;
1384	&signal	1543	&signal
1385	}
1386
1387	sub AnyEvent::Base::signal::DESTROY {
1388	my ($signal, $cb) = @{$_[0]};
1389
1390	_sig_del;
1391
1392	delete $SIG_CB{$signal}{$cb};
1393
1394	$HAVE_ASYNC_INTERRUPT
1395	? delete $SIG_ASY{$signal}
1396	: # delete doesn't work with older perls - they then
1397	# print weird messages, or just unconditionally exit
1398	# instead of getting the default action.
1399	undef $SIG{$signal}
1400	unless keys %{ $SIG_CB{$signal} };
1401	}	1544	}
1402		1545
1403	# default implementation for ->child	1546	# default implementation for ->child
1404		1547
1405	our %PID_CB;	1548	our %PID_CB;
1406	our $CHLD_W;	1549	our $CHLD_W;
1407	our $CHLD_DELAY_W;	1550	our $CHLD_DELAY_W;
1408	our $WNOHANG;	1551	our $WNOHANG;
1409		1552
		1553	sub _emit_childstatus($$) {
		1554	my (undef, $rpid, $rstatus) = @_;
		1555
		1556	$_->($rpid, $rstatus)
		1557	for values %{ $PID_CB{$rpid} \|\| {} },
		1558	values %{ $PID_CB{0} \|\| {} };
		1559	}
		1560
1410	sub _sigchld {	1561	sub _sigchld {
		1562	my $pid;
		1563
		1564	AnyEvent->_emit_childstatus ($pid, $?)
1411	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1565	while ($pid = waitpid -1, $WNOHANG) > 0;
1412	$_->($pid, $?)
1413	for values %{ $PID_CB{$pid} \|\| {} },
1414	values %{ $PID_CB{0} \|\| {} };
1415	}
1416	}	1566	}
1417		1567
1418	sub child {	1568	sub child {
1419	my (undef, %arg) = @_;	1569	my (undef, %arg) = @_;
1420		1570
…		…
1427	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1577	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1428	? 1	1578	? 1
1429	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1579	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1430		1580
1431	unless ($CHLD_W) {	1581	unless ($CHLD_W) {
1432	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1582	$CHLD_W = AE::signal CHLD => \&_sigchld;
1433	# child could be a zombie already, so make at least one round	1583	# child could be a zombie already, so make at least one round
1434	&_sigchld;	1584	&_sigchld;
1435	}	1585	}
1436		1586
1437	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1587	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1463	# never use more then 50% of the time for the idle watcher,	1613	# never use more then 50% of the time for the idle watcher,
1464	# within some limits	1614	# within some limits
1465	$w = 0.0001 if $w < 0.0001;	1615	$w = 0.0001 if $w < 0.0001;
1466	$w = 5 if $w > 5;	1616	$w = 5 if $w > 5;
1467		1617
1468	$w = AnyEvent->timer (after => $w, cb => $rcb);	1618	$w = AE::timer $w, 0, $rcb;
1469	} else {	1619	} else {
1470	# clean up...	1620	# clean up...
1471	undef $w;	1621	undef $w;
1472	undef $rcb;	1622	undef $rcb;
1473	}	1623	}
1474	};	1624	};
1475		1625
1476	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1626	$w = AE::timer 0.05, 0, $rcb;
1477		1627
1478	bless \\$cb, "AnyEvent::Base::idle"	1628	bless \\$cb, "AnyEvent::Base::idle"
1479	}	1629	}
1480		1630
1481	sub AnyEvent::Base::idle::DESTROY {	1631	sub AnyEvent::Base::idle::DESTROY {
…		…
1535	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1685	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1536	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1686	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1537	}	1687	}
1538		1688
1539	sub cb {	1689	sub cb {
1540	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1690	my $cv = shift;
		1691
		1692	@_
		1693	and $cv->{_ae_cb} = shift
		1694	and $cv->{_ae_sent}
		1695	and (delete $cv->{_ae_cb})->($cv);
		1696
1541	$_[0]{_ae_cb}	1697	$cv->{_ae_cb}
1542	}	1698	}
1543		1699
1544	sub begin {	1700	sub begin {
1545	++$_[0]{_ae_counter};	1701	++$_[0]{_ae_counter};
1546	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1702	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1905	through AnyEvent. The benchmark creates a lot of timers (with a zero	2061	through AnyEvent. The benchmark creates a lot of timers (with a zero
1906	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2062	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1907	which it is), lets them fire exactly once and destroys them again.	2063	which it is), lets them fire exactly once and destroys them again.
1908		2064
1909	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2065	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1910	distribution.	2066	distribution. It uses the L<AE> interface, which makes a real difference
		2067	for the EV and Perl backends only.
1911		2068
1912	=head3 Explanation of the columns	2069	=head3 Explanation of the columns
1913		2070
1914	I<watcher> is the number of event watchers created/destroyed. Since	2071	I<watcher> is the number of event watchers created/destroyed. Since
1915	different event models feature vastly different performances, each event	2072	different event models feature vastly different performances, each event
…		…
1936	watcher.	2093	watcher.
1937		2094
1938	=head3 Results	2095	=head3 Results
1939		2096
1940	name watchers bytes create invoke destroy comment	2097	name watchers bytes create invoke destroy comment
1941	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2098	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1942	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2099	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1943	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2100	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1944	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2101	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1945	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2102	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1946	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2103	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1947	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2104	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1948	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2105	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1949	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2106	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1950	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2107	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1951	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2108	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1952	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2109	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1953		2110
1954	=head3 Discussion	2111	=head3 Discussion
1955		2112
1956	The benchmark does I<not> measure scalability of the event loop very	2113	The benchmark does I<not> measure scalability of the event loop very
1957	well. For example, a select-based event loop (such as the pure perl one)	2114	well. For example, a select-based event loop (such as the pure perl one)
…		…
1969	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2126	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1970	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2127	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1971	cycles with POE.	2128	cycles with POE.
1972		2129
1973	C<EV> is the sole leader regarding speed and memory use, which are both	2130	C<EV> is the sole leader regarding speed and memory use, which are both
1974	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2131	maximal/minimal, respectively. When using the L<AE> API there is zero
		2132	overhead (when going through the AnyEvent API create is about 5-6 times
		2133	slower, with other times being equal, so still uses far less memory than
1975	far less memory than any other event loop and is still faster than Event	2134	any other event loop and is still faster than Event natively).
1976	natively.
1977		2135
1978	The pure perl implementation is hit in a few sweet spots (both the	2136	The pure perl implementation is hit in a few sweet spots (both the
1979	constant timeout and the use of a single fd hit optimisations in the perl	2137	constant timeout and the use of a single fd hit optimisations in the perl
1980	interpreter and the backend itself). Nevertheless this shows that it	2138	interpreter and the backend itself). Nevertheless this shows that it
1981	adds very little overhead in itself. Like any select-based backend its	2139	adds very little overhead in itself. Like any select-based backend its
…		…
2055	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2213	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2056	(1%) are active. This mirrors the activity of large servers with many	2214	(1%) are active. This mirrors the activity of large servers with many
2057	connections, most of which are idle at any one point in time.	2215	connections, most of which are idle at any one point in time.
2058		2216
2059	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2217	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2060	distribution.	2218	distribution. It uses the L<AE> interface, which makes a real difference
		2219	for the EV and Perl backends only.
2061		2220
2062	=head3 Explanation of the columns	2221	=head3 Explanation of the columns
2063		2222
2064	I<sockets> is the number of sockets, and twice the number of "servers" (as	2223	I<sockets> is the number of sockets, and twice the number of "servers" (as
2065	each server has a read and write socket end).	2224	each server has a read and write socket end).
…		…
2073	a new one that moves the timeout into the future.	2232	a new one that moves the timeout into the future.
2074		2233
2075	=head3 Results	2234	=head3 Results
2076		2235
2077	name sockets create request	2236	name sockets create request
2078	EV 20000 69.01 11.16	2237	EV 20000 62.66 7.99
2079	Perl 20000 73.32 35.87	2238	Perl 20000 68.32 32.64
2080	IOAsync 20000 157.00 98.14 epoll	2239	IOAsync 20000 174.06 101.15 epoll
2081	IOAsync 20000 159.31 616.06 poll	2240	IOAsync 20000 174.67 610.84 poll
2082	Event 20000 212.62 257.32	2241	Event 20000 202.69 242.91
2083	Glib 20000 651.16 1896.30	2242	Glib 20000 557.01 1689.52
2084	POE 20000 349.67 12317.24 uses POE::Loop::Event	2243	POE 20000 341.54 12086.32 uses POE::Loop::Event
2085		2244
2086	=head3 Discussion	2245	=head3 Discussion
2087		2246
2088	This benchmark I<does> measure scalability and overall performance of the	2247	This benchmark I<does> measure scalability and overall performance of the
2089	particular event loop.	2248	particular event loop.
…		…
2399	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2558	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2400		2559
2401	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2560	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2402	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2561	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2403	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2562	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2404	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2563	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2405		2564
2406	Non-blocking file handles, sockets, TCP clients and	2565	Non-blocking file handles, sockets, TCP clients and
2407	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2566	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2408		2567
2409	Asynchronous DNS: L<AnyEvent::DNS>.	2568	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.250 by root, Mon Jul 20 07:12:38 2009 UTC vs. Revision 1.278 by root, Sun Aug 9 15:09:28 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.250 by root, Mon Jul 20 07:12:38 2009 UTC vs.
Revision 1.278 by root, Sun Aug 9 15:09:28 2009 UTC