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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.306 by root, Tue Dec 15 05:49:13 2009 UTC vs.
Revision 1.329 by root, Sun Jul 11 05:44:22 2010 UTC

…		…
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
…		…
135	use AnyEvent;	138	use AnyEvent;
136		139
137	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
138		141
139	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
140	starts using it, all bets are off. Maybe you should tell their authors to	143	starts using it, all bets are off - this case should be very rare though,
141	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
142		146
143	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called
144	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
145	explicitly and enjoy the high availability of that event loop :)	149	explicitly and enjoy the high availability of that event loop :)
146		150
…		…
503		507
504	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
505		509
506	$w = AnyEvent->idle (cb => <callback>);	510	$w = AnyEvent->idle (cb => <callback>);
507		511
508	Sometimes there is a need to do something, but it is not so important	512	Repeatedly invoke the callback after the process becomes idle, until
509	to do it instantly, but only when there is nothing better to do. This	513	either the watcher is destroyed or new events have been detected.
510	"nothing better to do" is usually defined to be "no other events need
511	attention by the event loop".
512		514
513	Idle watchers ideally get invoked when the event loop has nothing	515	Idle watchers are useful when there is a need to do something, but it
514	better to do, just before it would block the process to wait for new	516	is not so important (or wise) to do it instantly. The callback will be
515	events. Instead of blocking, the idle watcher is invoked.	517	invoked only when there is "nothing better to do", which is usually
		518	defined as "all outstanding events have been handled and no new events
		519	have been detected". That means that idle watchers ideally get invoked
		520	when the event loop has just polled for new events but none have been
		521	detected. Instead of blocking to wait for more events, the idle watchers
		522	will be invoked.
516		523
517	Most event loops unfortunately do not really support idle watchers (only	524	Unfortunately, most event loops do not really support idle watchers (only
518	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	525	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
519	will simply call the callback "from time to time".	526	will simply call the callback "from time to time".
520		527
521	Example: read lines from STDIN, but only process them when the	528	Example: read lines from STDIN, but only process them when the
522	program is otherwise idle:	529	program is otherwise idle:
…		…
550	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
551		558
552	AnyEvent is slightly different: it expects somebody else to run the event	559	AnyEvent is slightly different: it expects somebody else to run the event
553	loop and will only block when necessary (usually when told by the user).	560	loop and will only block when necessary (usually when told by the user).
554		561
555	The instrument to do that is called a "condition variable", so called	562	The tool to do that is called a "condition variable", so called because
556	because they represent a condition that must become true.	563	they represent a condition that must become true.
557		564
558	Now is probably a good time to look at the examples further below.	565	Now is probably a good time to look at the examples further below.
559		566
560	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
561	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
…		…
566	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
567	by calling the C<send> method (or calling the condition variable as if it	574	by calling the C<send> method (or calling the condition variable as if it
568	were a callback, read about the caveats in the description for the C<<	575	were a callback, read about the caveats in the description for the C<<
569	->send >> method).	576	->send >> method).
570		577
571	Condition variables are similar to callbacks, except that you can	578	Since condition variables are the most complex part of the AnyEvent API, here are
572	optionally wait for them. They can also be called merge points - points	579	some different mental models of what they are - pick the ones you can connect to:
573	in time where multiple outstanding events have been processed. And yet	580
574	another way to call them is transactions - each condition variable can be	581	=over 4
575	used to represent a transaction, which finishes at some point and delivers	582
576	a result. And yet some people know them as "futures" - a promise to	583	=item * Condition variables are like callbacks - you can call them (and pass them instead
577	compute/deliver something that you can wait for.	584	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		585
		586	=item * Condition variables are signals - one side can emit or send them,
		587	the other side can wait for them, or install a handler that is called when
		588	the signal fires.
		589
		590	=item * Condition variables are like "Merge Points" - points in your program
		591	where you merge multiple independent results/control flows into one.
		592
		593	=item * Condition variables represent a transaction - function that start
		594	some kind of transaction can return them, leaving the caller the choice
		595	between waiting in a blocking fashion, or setting a callback.
		596
		597	=item * Condition variables represent future values, or promises to deliver
		598	some result, long before the result is available.
		599
		600	=back
578		601
579	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
580	for example, if you write a module that does asynchronous http requests,	603	for example, if you write a module that does asynchronous http requests,
581	then a condition variable would be the ideal candidate to signal the	604	then a condition variable would be the ideal candidate to signal the
582	availability of results. The user can either act when the callback is	605	availability of results. The user can either act when the callback is
…		…
603	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
604	for the send to occur.	627	for the send to occur.
605		628
606	Example: wait for a timer.	629	Example: wait for a timer.
607		630
608	# wait till the result is ready	631	# condition: "wait till the timer is fired"
609	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
610		633
611	# do something such as adding a timer	634	# create the timer - we could wait for, say
612	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
613	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
614	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
615	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
616	after => 1,	639	after => 1,
617	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
618	);	641	);
619		642
620	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
621	# calls ->send	644	# calls ->send
622	$result_ready->recv;	645	$timer_fired->recv;
623		646
624	Example: wait for a timer, but take advantage of the fact that condition	647	Example: wait for a timer, but take advantage of the fact that condition
625	variables are also callable directly.	648	variables are also callable directly.
626		649
627	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
…		…
1051	=head1 OTHER MODULES	1074	=head1 OTHER MODULES
1052		1075
1053	The following is a non-exhaustive list of additional modules that use	1076	The following is a non-exhaustive list of additional modules that use
1054	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1077	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1055	modules and other event loops in the same program. Some of the modules	1078	modules and other event loops in the same program. Some of the modules
1056	come with AnyEvent, most are available via CPAN.	1079	come as part of AnyEvent, the others are available via CPAN.
1057		1080
1058	=over 4	1081	=over 4
1059		1082
1060	=item L<AnyEvent::Util>	1083	=item L<AnyEvent::Util>
1061		1084
…		…
1076		1099
1077	=item L<AnyEvent::DNS>	1100	=item L<AnyEvent::DNS>
1078		1101
1079	Provides rich asynchronous DNS resolver capabilities.	1102	Provides rich asynchronous DNS resolver capabilities.
1080		1103
		1104	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1105
		1106	Implement event-based interfaces to the protocols of the same name (for
		1107	the curious, IGS is the International Go Server and FCP is the Freenet
		1108	Client Protocol).
		1109
		1110	=item L<AnyEvent::Handle::UDP>
		1111
		1112	Here be danger!
		1113
		1114	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1115	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1116	it's use of a stream-based API with a protocol that isn't streamable, that
		1117	the only way to improve it is to delete it.
		1118
		1119	It features data corruption (but typically only under load) and general
		1120	confusion. On top, the author is not only clueless about UDP but also
		1121	fact-resistant - some gems of his understanding: "connect doesn't work
		1122	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1123	packets", "I don't need to implement proper error checking as UDP doesn't
		1124	support error checking" and so on - he doesn't even understand what's
		1125	wrong with his module when it is explained to him.
		1126
1081	=item L<AnyEvent::HTTP>	1127	=item L<AnyEvent::DBI>
1082		1128
1083	A simple-to-use HTTP library that is capable of making a lot of concurrent	1129	Executes L<DBI> requests asynchronously in a proxy process for you,
1084	HTTP requests.	1130	notifying you in an event-bnased way when the operation is finished.
		1131
		1132	=item L<AnyEvent::AIO>
		1133
		1134	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1135	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1136	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1137	file I/O, and much more.
1085		1138
1086	=item L<AnyEvent::HTTPD>	1139	=item L<AnyEvent::HTTPD>
1087		1140
1088	Provides a simple web application server framework.	1141	A simple embedded webserver.
1089		1142
1090	=item L<AnyEvent::FastPing>	1143	=item L<AnyEvent::FastPing>
1091		1144
1092	The fastest ping in the west.	1145	The fastest ping in the west.
1093
1094	=item L<AnyEvent::DBI>
1095
1096	Executes L<DBI> requests asynchronously in a proxy process.
1097
1098	=item L<AnyEvent::AIO>
1099
1100	Truly asynchronous I/O, should be in the toolbox of every event
1101	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1102	together.
1103
1104	=item L<AnyEvent::BDB>
1105
1106	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1107	L<BDB> and AnyEvent together.
1108
1109	=item L<AnyEvent::GPSD>
1110
1111	A non-blocking interface to gpsd, a daemon delivering GPS information.
1112
1113	=item L<AnyEvent::IRC>
1114
1115	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1116
1117	=item L<AnyEvent::XMPP>
1118
1119	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1120	Net::XMPP2>.
1121
1122	=item L<AnyEvent::IGS>
1123
1124	A non-blocking interface to the Internet Go Server protocol (used by
1125	L<App::IGS>).
1126
1127	=item L<Net::FCP>
1128
1129	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1130	of AnyEvent.
1131
1132	=item L<Event::ExecFlow>
1133
1134	High level API for event-based execution flow control.
1135		1146
1136	=item L<Coro>	1147	=item L<Coro>
1137		1148
1138	Has special support for AnyEvent via L<Coro::AnyEvent>.	1149	Has special support for AnyEvent via L<Coro::AnyEvent>.
1139		1150
…		…
1153		1164
1154	BEGIN { AnyEvent::common_sense }	1165	BEGIN { AnyEvent::common_sense }
1155		1166
1156	use Carp ();	1167	use Carp ();
1157		1168
1158	our $VERSION = '5.22';	1169	our $VERSION = '5.271';
1159	our $MODEL;	1170	our $MODEL;
1160		1171
1161	our $AUTOLOAD;	1172	our $AUTOLOAD;
1162	our @ISA;	1173	our @ISA;
1163		1174
1164	our @REGISTRY;	1175	our @REGISTRY;
1165		1176
1166	our $VERBOSE;	1177	our $VERBOSE;
1167		1178
1168	BEGIN {	1179	BEGIN {
1169	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1180	require "AnyEvent/constants.pl";
		1181
1170	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1182	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1171		1183
1172	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1184	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1173	if ${^TAINT};	1185	if ${^TAINT};
1174		1186
1175	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1187	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1218	our @post_detect;	1230	our @post_detect;
1219		1231
1220	sub post_detect(&) {	1232	sub post_detect(&) {
1221	my ($cb) = @_;	1233	my ($cb) = @_;
1222		1234
1223	if ($MODEL) {
1224	$cb->();
1225
1226	undef
1227	} else {
1228	push @post_detect, $cb;	1235	push @post_detect, $cb;
1229		1236
1230	defined wantarray	1237	defined wantarray
1231	? bless \$cb, "AnyEvent::Util::postdetect"	1238	? bless \$cb, "AnyEvent::Util::postdetect"
1232	: ()	1239	: ()
1233	}
1234	}	1240	}
1235		1241
1236	sub AnyEvent::Util::postdetect::DESTROY {	1242	sub AnyEvent::Util::postdetect::DESTROY {
1237	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1243	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1238	}	1244	}
1239		1245
1240	sub detect() {	1246	sub detect() {
		1247	# free some memory
		1248	*detect = sub () { $MODEL };
		1249
		1250	local $!; # for good measure
		1251	local $SIG{__DIE__};
		1252
		1253	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1254	my $model = "AnyEvent::Impl::$1";
		1255	if (eval "require $model") {
		1256	$MODEL = $model;
		1257	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1258	} else {
		1259	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1260	}
		1261	}
		1262
		1263	# check for already loaded models
1241	unless ($MODEL) {	1264	unless ($MODEL) {
1242	local $SIG{__DIE__};	1265	for (@REGISTRY, @models) {
1243		1266	my ($package, $model) = @$_;
1244	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1267	if (${"$package\::VERSION"} > 0) {
1245	my $model = "AnyEvent::Impl::$1";
1246	if (eval "require $model") {	1268	if (eval "require $model") {
1247	$MODEL = $model;	1269	$MODEL = $model;
1248	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1270	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1249	} else {	1271	last;
1250	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1272	}
1251	}	1273	}
1252	}	1274	}
1253		1275
1254	# check for already loaded models
1255	unless ($MODEL) {	1276	unless ($MODEL) {
		1277	# try to autoload a model
1256	for (@REGISTRY, @models) {	1278	for (@REGISTRY, @models) {
1257	my ($package, $model) = @$_;	1279	my ($package, $model, $autoload) = @$_;
		1280	if (
		1281	$autoload
		1282	and eval "require $package"
1258	if (${"$package\::VERSION"} > 0) {	1283	and ${"$package\::VERSION"} > 0
1259	if (eval "require $model") {	1284	and eval "require $model"
		1285	) {
1260	$MODEL = $model;	1286	$MODEL = $model;
1261	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1287	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1262	last;	1288	last;
1263	}
1264	}	1289	}
1265	}	1290	}
1266		1291
1267	unless ($MODEL) {
1268	# try to autoload a model
1269	for (@REGISTRY, @models) {
1270	my ($package, $model, $autoload) = @$_;
1271	if (
1272	$autoload
1273	and eval "require $package"
1274	and ${"$package\::VERSION"} > 0
1275	and eval "require $model"
1276	) {
1277	$MODEL = $model;
1278	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1279	last;
1280	}
1281	}
1282
1283	$MODEL	1292	$MODEL
1284	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1293	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1285	}
1286	}	1294	}
1287
1288	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1289
1290	unshift @ISA, $MODEL;
1291
1292	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1293
1294	(shift @post_detect)->() while @post_detect;
1295	}	1295	}
		1296
		1297	@models = (); # free probe data
		1298
		1299	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1300	unshift @ISA, $MODEL;
		1301
		1302	# now nuke some methods that are overriden by the backend.
		1303	# SUPER is not allowed.
		1304	for (qw(time signal child idle)) {
		1305	undef &{"AnyEvent::Base::$_"}
		1306	if defined &{"$MODEL\::$_"};
		1307	}
		1308
		1309	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1310
		1311	(shift @post_detect)->() while @post_detect;
		1312
		1313	*post_detect = sub(&) {
		1314	shift->();
		1315
		1316	undef
		1317	};
1296		1318
1297	$MODEL	1319	$MODEL
1298	}	1320	}
1299		1321
1300	sub AUTOLOAD {	1322	sub AUTOLOAD {
1301	(my $func = $AUTOLOAD) =~ s/.*://;	1323	(my $func = $AUTOLOAD) =~ s/.*://;
1302		1324
1303	$method{$func}	1325	$method{$func}
1304	or Carp::croak "$func: not a valid method for AnyEvent objects";	1326	or Carp::croak "$func: not a valid AnyEvent class method";
1305		1327
1306	detect unless $MODEL;	1328	detect;
1307		1329
1308	my $class = shift;	1330	my $class = shift;
1309	$class->$func (@_);	1331	$class->$func (@_);
1310	}	1332	}
1311		1333
…		…
1328		1350
1329	=head1 SIMPLIFIED AE API	1351	=head1 SIMPLIFIED AE API
1330		1352
1331	Starting with version 5.0, AnyEvent officially supports a second, much	1353	Starting with version 5.0, AnyEvent officially supports a second, much
1332	simpler, API that is designed to reduce the calling, typing and memory	1354	simpler, API that is designed to reduce the calling, typing and memory
1333	overhead.	1355	overhead by using function call syntax and a fixed number of parameters.
1334		1356
1335	See the L<AE> manpage for details.	1357	See the L<AE> manpage for details.
1336		1358
1337	=cut	1359	=cut
1338		1360
1339	package AE;	1361	package AE;
1340		1362
1341	our $VERSION = $AnyEvent::VERSION;	1363	our $VERSION = $AnyEvent::VERSION;
		1364
		1365	# fall back to the main API by default - backends and AnyEvent::Base
		1366	# implementations can overwrite these.
1342		1367
1343	sub io($$$) {	1368	sub io($$$) {
1344	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1369	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1345	}	1370	}
1346		1371
…		…
1378		1403
1379	package AnyEvent::Base;	1404	package AnyEvent::Base;
1380		1405
1381	# default implementations for many methods	1406	# default implementations for many methods
1382		1407
1383	sub _time() {	1408	sub time {
		1409	eval q{ # poor man's autoloading {}
1384	# probe for availability of Time::HiRes	1410	# probe for availability of Time::HiRes
1385	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1411	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1386	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1412	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1387	*_time = \&Time::HiRes::time;	1413	*AE::time = \&Time::HiRes::time;
1388	# if (eval "use POSIX (); (POSIX::times())...	1414	# if (eval "use POSIX (); (POSIX::times())...
1389	} else {	1415	} else {
1390	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1416	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1391	*_time = sub { time }; # epic fail	1417	*AE::time = sub (){ time }; # epic fail
		1418	}
		1419
		1420	*time = sub { AE::time }; # different prototypes
1392	}	1421	};
		1422	die if $@;
1393		1423
1394	&_time	1424	&time
1395	}	1425	}
1396		1426
1397	sub time { _time }	1427	*now = \&time;
1398	sub now { _time }	1428
1399	sub now_update { }	1429	sub now_update { }
1400		1430
1401	# default implementation for ->condvar	1431	# default implementation for ->condvar
1402		1432
1403	sub condvar {	1433	sub condvar {
		1434	eval q{ # poor man's autoloading {}
		1435	*condvar = sub {
1404	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1436	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1437	};
		1438
		1439	*AE::cv = sub (;&) {
		1440	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1441	};
		1442	};
		1443	die if $@;
		1444
		1445	&condvar
1405	}	1446	}
1406		1447
1407	# default implementation for ->signal	1448	# default implementation for ->signal
1408		1449
1409	our $HAVE_ASYNC_INTERRUPT;	1450	our $HAVE_ASYNC_INTERRUPT;
…		…
1418		1459
1419	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1460	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1420	our (%SIG_ASY, %SIG_ASY_W);	1461	our (%SIG_ASY, %SIG_ASY_W);
1421	our ($SIG_COUNT, $SIG_TW);	1462	our ($SIG_COUNT, $SIG_TW);
1422		1463
1423	sub _signal_exec {
1424	$HAVE_ASYNC_INTERRUPT
1425	? $SIGPIPE_R->drain
1426	: sysread $SIGPIPE_R, (my $dummy), 9;
1427
1428	while (%SIG_EV) {
1429	for (keys %SIG_EV) {
1430	delete $SIG_EV{$_};
1431	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1432	}
1433	}
1434	}
1435
1436	# install a dummy wakeup watcher to reduce signal catching latency	1464	# install a dummy wakeup watcher to reduce signal catching latency
		1465	# used by Impls
1437	sub _sig_add() {	1466	sub _sig_add() {
1438	unless ($SIG_COUNT++) {	1467	unless ($SIG_COUNT++) {
1439	# try to align timer on a full-second boundary, if possible	1468	# try to align timer on a full-second boundary, if possible
1440	my $NOW = AE::now;	1469	my $NOW = AE::now;
1441		1470
…		…
1451	undef $SIG_TW	1480	undef $SIG_TW
1452	unless --$SIG_COUNT;	1481	unless --$SIG_COUNT;
1453	}	1482	}
1454		1483
1455	our $_sig_name_init; $_sig_name_init = sub {	1484	our $_sig_name_init; $_sig_name_init = sub {
1456	eval q{ # poor man's autoloading	1485	eval q{ # poor man's autoloading {}
1457	undef $_sig_name_init;	1486	undef $_sig_name_init;
1458		1487
1459	if (_have_async_interrupt) {	1488	if (_have_async_interrupt) {
1460	*sig2num = \&Async::Interrupt::sig2num;	1489	*sig2num = \&Async::Interrupt::sig2num;
1461	*sig2name = \&Async::Interrupt::sig2name;	1490	*sig2name = \&Async::Interrupt::sig2name;
…		…
1493	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1522	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1494		1523
1495	} else {	1524	} else {
1496	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1525	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1497		1526
1498	require Fcntl;
1499
1500	if (AnyEvent::WIN32) {	1527	if (AnyEvent::WIN32) {
1501	require AnyEvent::Util;	1528	require AnyEvent::Util;
1502		1529
1503	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1530	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1504	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1531	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1505	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1532	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1506	} else {	1533	} else {
1507	pipe $SIGPIPE_R, $SIGPIPE_W;	1534	pipe $SIGPIPE_R, $SIGPIPE_W;
1508	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1535	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1509	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1536	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1510		1537
1511	# not strictly required, as $^F is normally 2, but let's make sure...	1538	# not strictly required, as $^F is normally 2, but let's make sure...
1512	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1539	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1513	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1540	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1514	}	1541	}
1515		1542
1516	$SIGPIPE_R	1543	$SIGPIPE_R
1517	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1544	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1518		1545
1519	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1546	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1520	}	1547	}
1521		1548
1522	*signal = sub {	1549	*signal = $HAVE_ASYNC_INTERRUPT
		1550	? sub {
1523	my (undef, %arg) = @_;	1551	my (undef, %arg) = @_;
1524		1552
1525	my $signal = uc $arg{signal}
1526	or Carp::croak "required option 'signal' is missing";
1527
1528	if ($HAVE_ASYNC_INTERRUPT) {
1529	# async::interrupt	1553	# async::interrupt
1530
1531	$signal = sig2num $signal;	1554	my $signal = sig2num $arg{signal};
1532	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1555	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1533		1556
1534	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1557	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1535	cb => sub { undef $SIG_EV{$signal} },	1558	cb => sub { undef $SIG_EV{$signal} },
1536	signal => $signal,	1559	signal => $signal,
1537	pipe => [$SIGPIPE_R->filenos],	1560	pipe => [$SIGPIPE_R->filenos],
1538	pipe_autodrain => 0,	1561	pipe_autodrain => 0,
1539	;	1562	;
1540		1563
1541	} else {	1564	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1565	}
		1566	: sub {
		1567	my (undef, %arg) = @_;
		1568
1542	# pure perl	1569	# pure perl
1543
1544	# AE::Util has been loaded in signal
1545	$signal = sig2name $signal;	1570	my $signal = sig2name $arg{signal};
1546	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1571	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1547		1572
1548	$SIG{$signal} \|\|= sub {	1573	$SIG{$signal} \|\|= sub {
1549	local $!;	1574	local $!;
1550	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1575	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1551	undef $SIG_EV{$signal};	1576	undef $SIG_EV{$signal};
1552	};	1577	};
1553		1578
1554	# can't do signal processing without introducing races in pure perl,	1579	# can't do signal processing without introducing races in pure perl,
1555	# so limit the signal latency.	1580	# so limit the signal latency.
1556	_sig_add;	1581	_sig_add;
1557	}
1558		1582
1559	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1583	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1584	}
1560	};	1585	;
1561		1586
1562	*AnyEvent::Base::signal::DESTROY = sub {	1587	*AnyEvent::Base::signal::DESTROY = sub {
1563	my ($signal, $cb) = @{$_[0]};	1588	my ($signal, $cb) = @{$_[0]};
1564		1589
1565	_sig_del;	1590	_sig_del;
…		…
1572	# print weird messages, or just unconditionally exit	1597	# print weird messages, or just unconditionally exit
1573	# instead of getting the default action.	1598	# instead of getting the default action.
1574	undef $SIG{$signal}	1599	undef $SIG{$signal}
1575	unless keys %{ $SIG_CB{$signal} };	1600	unless keys %{ $SIG_CB{$signal} };
1576	};	1601	};
		1602
		1603	*_signal_exec = sub {
		1604	$HAVE_ASYNC_INTERRUPT
		1605	? $SIGPIPE_R->drain
		1606	: sysread $SIGPIPE_R, (my $dummy), 9;
		1607
		1608	while (%SIG_EV) {
		1609	for (keys %SIG_EV) {
		1610	delete $SIG_EV{$_};
		1611	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1612	}
		1613	}
		1614	};
1577	};	1615	};
1578	die if $@;	1616	die if $@;
		1617
1579	&signal	1618	&signal
1580	}	1619	}
1581		1620
1582	# default implementation for ->child	1621	# default implementation for ->child
1583		1622
1584	our %PID_CB;	1623	our %PID_CB;
1585	our $CHLD_W;	1624	our $CHLD_W;
1586	our $CHLD_DELAY_W;	1625	our $CHLD_DELAY_W;
1587	our $WNOHANG;	1626	our $WNOHANG;
1588		1627
		1628	# used by many Impl's
1589	sub _emit_childstatus($$) {	1629	sub _emit_childstatus($$) {
1590	my (undef, $rpid, $rstatus) = @_;	1630	my (undef, $rpid, $rstatus) = @_;
1591		1631
1592	$_->($rpid, $rstatus)	1632	$_->($rpid, $rstatus)
1593	for values %{ $PID_CB{$rpid} \|\| {} },	1633	for values %{ $PID_CB{$rpid} \|\| {} },
1594	values %{ $PID_CB{0} \|\| {} };	1634	values %{ $PID_CB{0} \|\| {} };
1595	}	1635	}
1596		1636
1597	sub _sigchld {
1598	my $pid;
1599
1600	AnyEvent->_emit_childstatus ($pid, $?)
1601	while ($pid = waitpid -1, $WNOHANG) > 0;
1602	}
1603
1604	sub child {	1637	sub child {
		1638	eval q{ # poor man's autoloading {}
		1639	*_sigchld = sub {
		1640	my $pid;
		1641
		1642	AnyEvent->_emit_childstatus ($pid, $?)
		1643	while ($pid = waitpid -1, $WNOHANG) > 0;
		1644	};
		1645
		1646	*child = sub {
1605	my (undef, %arg) = @_;	1647	my (undef, %arg) = @_;
1606		1648
1607	defined (my $pid = $arg{pid} + 0)	1649	defined (my $pid = $arg{pid} + 0)
1608	or Carp::croak "required option 'pid' is missing";	1650	or Carp::croak "required option 'pid' is missing";
1609		1651
1610	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1652	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1611		1653
1612	# WNOHANG is almost cetrainly 1 everywhere	1654	# WNOHANG is almost cetrainly 1 everywhere
1613	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1655	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1614	? 1	1656	? 1
1615	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1657	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1616		1658
1617	unless ($CHLD_W) {	1659	unless ($CHLD_W) {
1618	$CHLD_W = AE::signal CHLD => \&_sigchld;	1660	$CHLD_W = AE::signal CHLD => \&_sigchld;
1619	# child could be a zombie already, so make at least one round	1661	# child could be a zombie already, so make at least one round
1620	&_sigchld;	1662	&_sigchld;
1621	}	1663	}
1622		1664
1623	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1665	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1624	}	1666	};
1625		1667
1626	sub AnyEvent::Base::child::DESTROY {	1668	*AnyEvent::Base::child::DESTROY = sub {
1627	my ($pid, $cb) = @{$_[0]};	1669	my ($pid, $cb) = @{$_[0]};
1628		1670
1629	delete $PID_CB{$pid}{$cb};	1671	delete $PID_CB{$pid}{$cb};
1630	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1672	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1631		1673
1632	undef $CHLD_W unless keys %PID_CB;	1674	undef $CHLD_W unless keys %PID_CB;
		1675	};
		1676	};
		1677	die if $@;
		1678
		1679	&child
1633	}	1680	}
1634		1681
1635	# idle emulation is done by simply using a timer, regardless	1682	# idle emulation is done by simply using a timer, regardless
1636	# of whether the process is idle or not, and not letting	1683	# of whether the process is idle or not, and not letting
1637	# the callback use more than 50% of the time.	1684	# the callback use more than 50% of the time.
1638	sub idle {	1685	sub idle {
		1686	eval q{ # poor man's autoloading {}
		1687	*idle = sub {
1639	my (undef, %arg) = @_;	1688	my (undef, %arg) = @_;
1640		1689
1641	my ($cb, $w, $rcb) = $arg{cb};	1690	my ($cb, $w, $rcb) = $arg{cb};
1642		1691
1643	$rcb = sub {	1692	$rcb = sub {
1644	if ($cb) {	1693	if ($cb) {
1645	$w = _time;	1694	$w = _time;
1646	&$cb;	1695	&$cb;
1647	$w = _time - $w;	1696	$w = _time - $w;
1648		1697
1649	# never use more then 50% of the time for the idle watcher,	1698	# never use more then 50% of the time for the idle watcher,
1650	# within some limits	1699	# within some limits
1651	$w = 0.0001 if $w < 0.0001;	1700	$w = 0.0001 if $w < 0.0001;
1652	$w = 5 if $w > 5;	1701	$w = 5 if $w > 5;
1653		1702
1654	$w = AE::timer $w, 0, $rcb;	1703	$w = AE::timer $w, 0, $rcb;
1655	} else {	1704	} else {
1656	# clean up...	1705	# clean up...
1657	undef $w;	1706	undef $w;
1658	undef $rcb;	1707	undef $rcb;
		1708	}
		1709	};
		1710
		1711	$w = AE::timer 0.05, 0, $rcb;
		1712
		1713	bless \\$cb, "AnyEvent::Base::idle"
1659	}	1714	};
		1715
		1716	*AnyEvent::Base::idle::DESTROY = sub {
		1717	undef $${$_[0]};
		1718	};
1660	};	1719	};
		1720	die if $@;
1661		1721
1662	$w = AE::timer 0.05, 0, $rcb;	1722	&idle
1663
1664	bless \\$cb, "AnyEvent::Base::idle"
1665	}
1666
1667	sub AnyEvent::Base::idle::DESTROY {
1668	undef $${$_[0]};
1669	}	1723	}
1670		1724
1671	package AnyEvent::CondVar;	1725	package AnyEvent::CondVar;
1672		1726
1673	our @ISA = AnyEvent::CondVar::Base::;	1727	our @ISA = AnyEvent::CondVar::Base::;
…		…
2032		2086
2033	The actual code goes further and collects all errors (C<die>s, exceptions)	2087	The actual code goes further and collects all errors (C<die>s, exceptions)
2034	that occurred during request processing. The C<result> method detects	2088	that occurred during request processing. The C<result> method detects
2035	whether an exception as thrown (it is stored inside the $txn object)	2089	whether an exception as thrown (it is stored inside the $txn object)
2036	and just throws the exception, which means connection errors and other	2090	and just throws the exception, which means connection errors and other
2037	problems get reported tot he code that tries to use the result, not in a	2091	problems get reported to the code that tries to use the result, not in a
2038	random callback.	2092	random callback.
2039		2093
2040	All of this enables the following usage styles:	2094	All of this enables the following usage styles:
2041		2095
2042	1. Blocking:	2096	1. Blocking:
…		…
2499	automatic timer adjustments even when no monotonic clock is available,	2553	automatic timer adjustments even when no monotonic clock is available,
2500	can take avdantage of advanced kernel interfaces such as C<epoll> and	2554	can take avdantage of advanced kernel interfaces such as C<epoll> and
2501	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2555	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2502	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2556	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2503		2557
		2558	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2559	then this module will do nothing for you.
		2560
2504	=item L<Guard>	2561	=item L<Guard>
2505		2562
2506	The guard module, when used, will be used to implement	2563	The guard module, when used, will be used to implement
2507	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2564	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2508	lot less memory), but otherwise doesn't affect guard operation much. It is	2565	lot less memory), but otherwise doesn't affect guard operation much. It is
2509	purely used for performance.	2566	purely used for performance.
2510		2567
2511	=item L<JSON> and L<JSON::XS>	2568	=item L<JSON> and L<JSON::XS>
2512		2569
2513	One of these modules is required when you want to read or write JSON data	2570	One of these modules is required when you want to read or write JSON data
2514	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2571	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2515	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2572	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2516
2517	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2518	installed.
2519		2573
2520	=item L<Net::SSLeay>	2574	=item L<Net::SSLeay>
2521		2575
2522	Implementing TLS/SSL in Perl is certainly interesting, but not very	2576	Implementing TLS/SSL in Perl is certainly interesting, but not very
2523	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2577	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2534		2588
2535		2589
2536	=head1 FORK	2590	=head1 FORK
2537		2591
2538	Most event libraries are not fork-safe. The ones who are usually are	2592	Most event libraries are not fork-safe. The ones who are usually are
2539	because they rely on inefficient but fork-safe C<select> or C<poll>	2593	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2540	calls. Only L<EV> is fully fork-aware.	2594	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2595	are usually badly thought-out hacks that are incompatible with fork in
		2596	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2597	continue event-processing in both parent and child (or both, if you know
		2598	what you are doing).
2541		2599
2542	This means that, in general, you cannot fork and do event processing	2600	This means that, in general, you cannot fork and do event processing in
2543	in the child if a watcher was created before the fork (which in turn	2601	the child if the event library was initialised before the fork (which
2544	initialises the event library).	2602	usually happens when the first AnyEvent watcher is created, or the library
		2603	is loaded).
2545		2604
2546	If you have to fork, you must either do so I<before> creating your first	2605	If you have to fork, you must either do so I<before> creating your first
2547	watcher OR you must not use AnyEvent at all in the child OR you must do	2606	watcher OR you must not use AnyEvent at all in the child OR you must do
2548	something completely out of the scope of AnyEvent.	2607	something completely out of the scope of AnyEvent.
2549		2608
2550	The problem of doing event processing in the parent I<and> the child	2609	The problem of doing event processing in the parent I<and> the child
2551	is much more complicated: even for backends that I<are> fork-aware or	2610	is much more complicated: even for backends that I<are> fork-aware or
2552	fork-safe, their behaviour is not usually what you want: fork clones all	2611	fork-safe, their behaviour is not usually what you want: fork clones all
2553	watchers, that means all timers, I/O watchers etc. are active in both	2612	watchers, that means all timers, I/O watchers etc. are active in both
2554	parent and child, which is almost never what you want.	2613	parent and child, which is almost never what you want. USing C<exec>
		2614	to start worker children from some kind of manage rprocess is usually
		2615	preferred, because it is much easier and cleaner, at the expense of having
		2616	to have another binary.
2555		2617
2556		2618
2557	=head1 SECURITY CONSIDERATIONS	2619	=head1 SECURITY CONSIDERATIONS
2558		2620
2559	AnyEvent can be forced to load any event model via	2621	AnyEvent can be forced to load any event model via

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.306 by root, Tue Dec 15 05:49:13 2009 UTC vs. Revision 1.329 by root, Sun Jul 11 05:44:22 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.306 by root, Tue Dec 15 05:49:13 2009 UTC vs.
Revision 1.329 by root, Sun Jul 11 05:44:22 2010 UTC