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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.292 by root, Mon Sep 14 05:05:09 2009 UTC vs.
Revision 1.323 by root, Thu May 20 21:22:20 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 => ...
…		…
363	might affect timers and time-outs.	366	might affect timers and time-outs.
364		367
365	When this is the case, you can call this method, which will update the	368	When this is the case, you can call this method, which will update the
366	event loop's idea of "current time".	369	event loop's idea of "current time".
367		370
		371	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		372	when mod_perl executes the script, then the event loop will have the wrong
		373	idea about the "current time" (being potentially far in the past, when the
		374	script ran the last time). In that case you should arrange a call to C<<
		375	AnyEvent->now_update >> each time the web server process wakes up again
		376	(e.g. at the start of your script, or in a handler).
		377
368	Note that updating the time I<might> cause some events to be handled.	378	Note that updating the time I<might> cause some events to be handled.
369		379
370	=back	380	=back
371		381
372	=head2 SIGNAL WATCHERS	382	=head2 SIGNAL WATCHERS
…		…
395	correctly.	405	correctly.
396		406
397	Example: exit on SIGINT	407	Example: exit on SIGINT
398		408
399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	409	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		410
		411	=head3 Restart Behaviour
		412
		413	While restart behaviour is up to the event loop implementation, most will
		414	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		415	pure perl implementation).
		416
		417	=head3 Safe/Unsafe Signals
		418
		419	Perl signals can be either "safe" (synchronous to opcode handling) or
		420	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		421	latter might corrupt your memory.
		422
		423	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		424	i.e. they will not interrupt your running perl program but will only be
		425	called as part of the normal event handling (just like timer, I/O etc.
		426	callbacks, too).
400		427
401	=head3 Signal Races, Delays and Workarounds	428	=head3 Signal Races, Delays and Workarounds
402		429
403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	430	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
404	callbacks to signals in a generic way, which is a pity, as you cannot	431	callbacks to signals in a generic way, which is a pity, as you cannot
…		…
479		506
480	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
481		508
482	$w = AnyEvent->idle (cb => <callback>);	509	$w = AnyEvent->idle (cb => <callback>);
483		510
484	Sometimes there is a need to do something, but it is not so important	511	Repeatedly invoke the callback after the process becomes idle, until
485	to do it instantly, but only when there is nothing better to do. This	512	either the watcher is destroyed or new events have been detected.
486	"nothing better to do" is usually defined to be "no other events need
487	attention by the event loop".
488		513
489	Idle watchers ideally get invoked when the event loop has nothing	514	Idle watchers are useful when there is a need to do something, but it
490	better to do, just before it would block the process to wait for new	515	is not so important (or wise) to do it instantly. The callback will be
491	events. Instead of blocking, the idle watcher is invoked.	516	invoked only when there is "nothing better to do", which is usually
		517	defined as "all outstanding events have been handled and no new events
		518	have been detected". That means that idle watchers ideally get invoked
		519	when the event loop has just polled for new events but none have been
		520	detected. Instead of blocking to wait for more events, the idle watchers
		521	will be invoked.
492		522
493	Most event loops unfortunately do not really support idle watchers (only	523	Unfortunately, most event loops do not really support idle watchers (only
494	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	524	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
496		526
497	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
498	program is otherwise idle:	528	program is otherwise idle:
…		…
579	eventually calls C<< -> send >>, and the "consumer side", which waits	609	eventually calls C<< -> send >>, and the "consumer side", which waits
580	for the send to occur.	610	for the send to occur.
581		611
582	Example: wait for a timer.	612	Example: wait for a timer.
583		613
584	# wait till the result is ready	614	# condition: "wait till the timer is fired"
585	my $result_ready = AnyEvent->condvar;	615	my $timer_fired = AnyEvent->condvar;
586		616
587	# do something such as adding a timer	617	# create the timer - we could wait for, say
588	# or socket watcher the calls $result_ready->send	618	# a handle becomign ready, or even an
589	# when the "result" is ready.	619	# AnyEvent::HTTP request to finish, but
590	# in this case, we simply use a timer:	620	# in this case, we simply use a timer:
591	my $w = AnyEvent->timer (	621	my $w = AnyEvent->timer (
592	after => 1,	622	after => 1,
593	cb => sub { $result_ready->send },	623	cb => sub { $timer_fired->send },
594	);	624	);
595		625
596	# this "blocks" (while handling events) till the callback	626	# this "blocks" (while handling events) till the callback
597	# calls ->send	627	# calls ->send
598	$result_ready->recv;	628	$timer_fired->recv;
599		629
600	Example: wait for a timer, but take advantage of the fact that condition	630	Example: wait for a timer, but take advantage of the fact that condition
601	variables are also callable directly.	631	variables are also callable directly.
602		632
603	my $done = AnyEvent->condvar;	633	my $done = AnyEvent->condvar;
…		…
942	You should check C<$AnyEvent::MODEL> before adding to this array, though:	972	You should check C<$AnyEvent::MODEL> before adding to this array, though:
943	if it is defined then the event loop has already been detected, and the	973	if it is defined then the event loop has already been detected, and the
944	array will be ignored.	974	array will be ignored.
945		975
946	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	976	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
947	it,as it takes care of these details.	977	it, as it takes care of these details.
948		978
949	This variable is mainly useful for modules that can do something useful	979	This variable is mainly useful for modules that can do something useful
950	when AnyEvent is used and thus want to know when it is initialised, but do	980	when AnyEvent is used and thus want to know when it is initialised, but do
951	not need to even load it by default. This array provides the means to hook	981	not need to even load it by default. This array provides the means to hook
952	into AnyEvent passively, without loading it.	982	into AnyEvent passively, without loading it.
		983
		984	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		985	together, you could put this into Coro (this is the actual code used by
		986	Coro to accomplish this):
		987
		988	if (defined $AnyEvent::MODEL) {
		989	# AnyEvent already initialised, so load Coro::AnyEvent
		990	require Coro::AnyEvent;
		991	} else {
		992	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		993	# as soon as it is
		994	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		995	}
953		996
954	=back	997	=back
955		998
956	=head1 WHAT TO DO IN A MODULE	999	=head1 WHAT TO DO IN A MODULE
957		1000
…		…
1039		1082
1040	=item L<AnyEvent::DNS>	1083	=item L<AnyEvent::DNS>
1041		1084
1042	Provides rich asynchronous DNS resolver capabilities.	1085	Provides rich asynchronous DNS resolver capabilities.
1043		1086
		1087	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1088
		1089	Implement event-based interfaces to the protocols of the same name (for
		1090	the curious, IGS is the International Go Server and FCP is the Freenet
		1091	Client Protocol).
		1092
		1093	=item L<AnyEvent::Handle::UDP>
		1094
		1095	Here be danger!
		1096
		1097	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1098	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1099	it's use of a stream-based API with a protocol that isn't streamable, that
		1100	the only way to improve it is to delete it.
		1101
		1102	It features data corruption (but typically only under load) and general
		1103	confusion. On top, the author is not only clueless about UDP but also
		1104	fact-resistant - some gems of his understanding: "connect doesn't work
		1105	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1106	packets", "I don't need to implement proper error checking as UDP doesn't
		1107	support error checking" and so on - he doesn't even understand what's
		1108	wrong with his module when it is explained to him.
		1109
1044	=item L<AnyEvent::HTTP>	1110	=item L<AnyEvent::DBI>
1045		1111
1046	A simple-to-use HTTP library that is capable of making a lot of concurrent	1112	Executes L<DBI> requests asynchronously in a proxy process for you,
1047	HTTP requests.	1113	notifying you in an event-bnased way when the operation is finished.
		1114
		1115	=item L<AnyEvent::AIO>
		1116
		1117	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1118	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1119	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1120	file I/O, and much more.
1048		1121
1049	=item L<AnyEvent::HTTPD>	1122	=item L<AnyEvent::HTTPD>
1050		1123
1051	Provides a simple web application server framework.	1124	A simple embedded webserver.
1052		1125
1053	=item L<AnyEvent::FastPing>	1126	=item L<AnyEvent::FastPing>
1054		1127
1055	The fastest ping in the west.	1128	The fastest ping in the west.
1056
1057	=item L<AnyEvent::DBI>
1058
1059	Executes L<DBI> requests asynchronously in a proxy process.
1060
1061	=item L<AnyEvent::AIO>
1062
1063	Truly asynchronous I/O, should be in the toolbox of every event
1064	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1065	together.
1066
1067	=item L<AnyEvent::BDB>
1068
1069	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1070	L<BDB> and AnyEvent together.
1071
1072	=item L<AnyEvent::GPSD>
1073
1074	A non-blocking interface to gpsd, a daemon delivering GPS information.
1075
1076	=item L<AnyEvent::IRC>
1077
1078	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1079
1080	=item L<AnyEvent::XMPP>
1081
1082	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1083	Net::XMPP2>.
1084
1085	=item L<AnyEvent::IGS>
1086
1087	A non-blocking interface to the Internet Go Server protocol (used by
1088	L<App::IGS>).
1089
1090	=item L<Net::FCP>
1091
1092	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1093	of AnyEvent.
1094
1095	=item L<Event::ExecFlow>
1096
1097	High level API for event-based execution flow control.
1098		1129
1099	=item L<Coro>	1130	=item L<Coro>
1100		1131
1101	Has special support for AnyEvent via L<Coro::AnyEvent>.	1132	Has special support for AnyEvent via L<Coro::AnyEvent>.
1102		1133
…		…
1107	package AnyEvent;	1138	package AnyEvent;
1108		1139
1109	# basically a tuned-down version of common::sense	1140	# basically a tuned-down version of common::sense
1110	sub common_sense {	1141	sub common_sense {
1111	# from common:.sense 1.0	1142	# from common:.sense 1.0
1112	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";	1143	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1113	# use strict vars subs	1144	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1114	$^H \|= 0x00000600;	1145	$^H \|= 0x00000600;
1115	}	1146	}
1116		1147
1117	BEGIN { AnyEvent::common_sense }	1148	BEGIN { AnyEvent::common_sense }
1118		1149
1119	use Carp ();	1150	use Carp ();
1120		1151
1121	our $VERSION = '5.2';	1152	our $VERSION = '5.261';
1122	our $MODEL;	1153	our $MODEL;
1123		1154
1124	our $AUTOLOAD;	1155	our $AUTOLOAD;
1125	our @ISA;	1156	our @ISA;
1126		1157
1127	our @REGISTRY;	1158	our @REGISTRY;
1128		1159
1129	our $WIN32;
1130
1131	our $VERBOSE;	1160	our $VERBOSE;
1132		1161
1133	BEGIN {	1162	BEGIN {
1134	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1163	require "AnyEvent/constants.pl";
		1164
1135	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1165	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1136		1166
1137	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1167	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1138	if ${^TAINT};	1168	if ${^TAINT};
1139		1169
1140	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1170	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1183	our @post_detect;	1213	our @post_detect;
1184		1214
1185	sub post_detect(&) {	1215	sub post_detect(&) {
1186	my ($cb) = @_;	1216	my ($cb) = @_;
1187		1217
1188	if ($MODEL) {
1189	$cb->();
1190
1191	undef
1192	} else {
1193	push @post_detect, $cb;	1218	push @post_detect, $cb;
1194		1219
1195	defined wantarray	1220	defined wantarray
1196	? bless \$cb, "AnyEvent::Util::postdetect"	1221	? bless \$cb, "AnyEvent::Util::postdetect"
1197	: ()	1222	: ()
1198	}
1199	}	1223	}
1200		1224
1201	sub AnyEvent::Util::postdetect::DESTROY {	1225	sub AnyEvent::Util::postdetect::DESTROY {
1202	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1226	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1203	}	1227	}
1204		1228
1205	sub detect() {	1229	sub detect() {
		1230	# free some memory
		1231	*detect = sub () { $MODEL };
		1232
		1233	local $!; # for good measure
		1234	local $SIG{__DIE__};
		1235
		1236	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1237	my $model = "AnyEvent::Impl::$1";
		1238	if (eval "require $model") {
		1239	$MODEL = $model;
		1240	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1241	} else {
		1242	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1243	}
		1244	}
		1245
		1246	# check for already loaded models
1206	unless ($MODEL) {	1247	unless ($MODEL) {
1207	local $SIG{__DIE__};	1248	for (@REGISTRY, @models) {
1208		1249	my ($package, $model) = @$_;
1209	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1250	if (${"$package\::VERSION"} > 0) {
1210	my $model = "AnyEvent::Impl::$1";
1211	if (eval "require $model") {	1251	if (eval "require $model") {
1212	$MODEL = $model;	1252	$MODEL = $model;
1213	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1253	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1214	} else {	1254	last;
1215	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1255	}
1216	}	1256	}
1217	}	1257	}
1218		1258
1219	# check for already loaded models
1220	unless ($MODEL) {	1259	unless ($MODEL) {
		1260	# try to autoload a model
1221	for (@REGISTRY, @models) {	1261	for (@REGISTRY, @models) {
1222	my ($package, $model) = @$_;	1262	my ($package, $model, $autoload) = @$_;
		1263	if (
		1264	$autoload
		1265	and eval "require $package"
1223	if (${"$package\::VERSION"} > 0) {	1266	and ${"$package\::VERSION"} > 0
1224	if (eval "require $model") {	1267	and eval "require $model"
		1268	) {
1225	$MODEL = $model;	1269	$MODEL = $model;
1226	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1270	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1227	last;	1271	last;
1228	}
1229	}	1272	}
1230	}	1273	}
1231		1274
1232	unless ($MODEL) {
1233	# try to autoload a model
1234	for (@REGISTRY, @models) {
1235	my ($package, $model, $autoload) = @$_;
1236	if (
1237	$autoload
1238	and eval "require $package"
1239	and ${"$package\::VERSION"} > 0
1240	and eval "require $model"
1241	) {
1242	$MODEL = $model;
1243	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1244	last;
1245	}
1246	}
1247
1248	$MODEL	1275	$MODEL
1249	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1276	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1250	}
1251	}	1277	}
1252
1253	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1254
1255	unshift @ISA, $MODEL;
1256
1257	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1258
1259	(shift @post_detect)->() while @post_detect;
1260	}	1278	}
		1279
		1280	@models = (); # free probe data
		1281
		1282	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1283	unshift @ISA, $MODEL;
		1284
		1285	# now nuke some methods that are overriden by the backend.
		1286	# SUPER is not allowed.
		1287	for (qw(time signal child idle)) {
		1288	undef &{"AnyEvent::Base::$_"}
		1289	if defined &{"$MODEL\::$_"};
		1290	}
		1291
		1292	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1293
		1294	(shift @post_detect)->() while @post_detect;
		1295
		1296	*post_detect = sub(&) {
		1297	shift->();
		1298
		1299	undef
		1300	};
1261		1301
1262	$MODEL	1302	$MODEL
1263	}	1303	}
1264		1304
1265	sub AUTOLOAD {	1305	sub AUTOLOAD {
1266	(my $func = $AUTOLOAD) =~ s/.*://;	1306	(my $func = $AUTOLOAD) =~ s/.*://;
1267		1307
1268	$method{$func}	1308	$method{$func}
1269	or Carp::croak "$func: not a valid method for AnyEvent objects";	1309	or Carp::croak "$func: not a valid AnyEvent class method";
1270		1310
1271	detect unless $MODEL;	1311	detect;
1272		1312
1273	my $class = shift;	1313	my $class = shift;
1274	$class->$func (@_);	1314	$class->$func (@_);
1275	}	1315	}
1276		1316
…		…
1293		1333
1294	=head1 SIMPLIFIED AE API	1334	=head1 SIMPLIFIED AE API
1295		1335
1296	Starting with version 5.0, AnyEvent officially supports a second, much	1336	Starting with version 5.0, AnyEvent officially supports a second, much
1297	simpler, API that is designed to reduce the calling, typing and memory	1337	simpler, API that is designed to reduce the calling, typing and memory
1298	overhead.	1338	overhead by using function call syntax and a fixed number of parameters.
1299		1339
1300	See the L<AE> manpage for details.	1340	See the L<AE> manpage for details.
1301		1341
1302	=cut	1342	=cut
1303		1343
1304	package AE;	1344	package AE;
1305		1345
1306	our $VERSION = $AnyEvent::VERSION;	1346	our $VERSION = $AnyEvent::VERSION;
		1347
		1348	# fall back to the main API by default - backends and AnyEvent::Base
		1349	# implementations can overwrite these.
1307		1350
1308	sub io($$$) {	1351	sub io($$$) {
1309	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1352	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1310	}	1353	}
1311		1354
…		…
1343		1386
1344	package AnyEvent::Base;	1387	package AnyEvent::Base;
1345		1388
1346	# default implementations for many methods	1389	# default implementations for many methods
1347		1390
1348	sub _time() {	1391	sub time {
		1392	eval q{ # poor man's autoloading {}
1349	# probe for availability of Time::HiRes	1393	# probe for availability of Time::HiRes
1350	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1394	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1351	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1395	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1352	*_time = \&Time::HiRes::time;	1396	*AE::time = \&Time::HiRes::time;
1353	# if (eval "use POSIX (); (POSIX::times())...	1397	# if (eval "use POSIX (); (POSIX::times())...
1354	} else {	1398	} else {
1355	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1399	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1356	*_time = sub { time }; # epic fail	1400	*AE::time = sub (){ time }; # epic fail
		1401	}
		1402
		1403	*time = sub { AE::time }; # different prototypes
1357	}	1404	};
		1405	die if $@;
1358		1406
1359	&_time	1407	&time
1360	}	1408	}
1361		1409
1362	sub time { _time }	1410	*now = \&time;
1363	sub now { _time }	1411
1364	sub now_update { }	1412	sub now_update { }
1365		1413
1366	# default implementation for ->condvar	1414	# default implementation for ->condvar
1367		1415
1368	sub condvar {	1416	sub condvar {
		1417	eval q{ # poor man's autoloading {}
		1418	*condvar = sub {
1369	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1419	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1420	};
		1421
		1422	*AE::cv = sub (;&) {
		1423	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1424	};
		1425	};
		1426	die if $@;
		1427
		1428	&condvar
1370	}	1429	}
1371		1430
1372	# default implementation for ->signal	1431	# default implementation for ->signal
1373		1432
1374	our $HAVE_ASYNC_INTERRUPT;	1433	our $HAVE_ASYNC_INTERRUPT;
…		…
1383		1442
1384	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1443	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1385	our (%SIG_ASY, %SIG_ASY_W);	1444	our (%SIG_ASY, %SIG_ASY_W);
1386	our ($SIG_COUNT, $SIG_TW);	1445	our ($SIG_COUNT, $SIG_TW);
1387		1446
1388	sub _signal_exec {
1389	$HAVE_ASYNC_INTERRUPT
1390	? $SIGPIPE_R->drain
1391	: sysread $SIGPIPE_R, my $dummy, 9;
1392
1393	while (%SIG_EV) {
1394	for (keys %SIG_EV) {
1395	delete $SIG_EV{$_};
1396	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1397	}
1398	}
1399	}
1400
1401	# install a dummy wakeup watcher to reduce signal catching latency	1447	# install a dummy wakeup watcher to reduce signal catching latency
		1448	# used by Impls
1402	sub _sig_add() {	1449	sub _sig_add() {
1403	unless ($SIG_COUNT++) {	1450	unless ($SIG_COUNT++) {
1404	# try to align timer on a full-second boundary, if possible	1451	# try to align timer on a full-second boundary, if possible
1405	my $NOW = AE::now;	1452	my $NOW = AE::now;
1406		1453
…		…
1416	undef $SIG_TW	1463	undef $SIG_TW
1417	unless --$SIG_COUNT;	1464	unless --$SIG_COUNT;
1418	}	1465	}
1419		1466
1420	our $_sig_name_init; $_sig_name_init = sub {	1467	our $_sig_name_init; $_sig_name_init = sub {
1421	eval q{ # poor man's autoloading	1468	eval q{ # poor man's autoloading {}
1422	undef $_sig_name_init;	1469	undef $_sig_name_init;
1423		1470
1424	if (_have_async_interrupt) {	1471	if (_have_async_interrupt) {
1425	*sig2num = \&Async::Interrupt::sig2num;	1472	*sig2num = \&Async::Interrupt::sig2num;
1426	*sig2name = \&Async::Interrupt::sig2name;	1473	*sig2name = \&Async::Interrupt::sig2name;
…		…
1458	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1505	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1459		1506
1460	} else {	1507	} else {
1461	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1508	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1462		1509
1463	require Fcntl;
1464
1465	if (AnyEvent::WIN32) {	1510	if (AnyEvent::WIN32) {
1466	require AnyEvent::Util;	1511	require AnyEvent::Util;
1467		1512
1468	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1513	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1514	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1470	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1515	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1471	} else {	1516	} else {
1472	pipe $SIGPIPE_R, $SIGPIPE_W;	1517	pipe $SIGPIPE_R, $SIGPIPE_W;
1473	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1518	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1474	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1519	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1475		1520
1476	# not strictly required, as $^F is normally 2, but let's make sure...	1521	# not strictly required, as $^F is normally 2, but let's make sure...
1477	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1522	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1478	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1523	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1479	}	1524	}
1480		1525
1481	$SIGPIPE_R	1526	$SIGPIPE_R
1482	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1527	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1483		1528
1484	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1529	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1485	}	1530	}
1486		1531
1487	*signal = sub {	1532	*signal = $HAVE_ASYNC_INTERRUPT
		1533	? sub {
1488	my (undef, %arg) = @_;	1534	my (undef, %arg) = @_;
1489		1535
1490	my $signal = uc $arg{signal}
1491	or Carp::croak "required option 'signal' is missing";
1492
1493	if ($HAVE_ASYNC_INTERRUPT) {
1494	# async::interrupt	1536	# async::interrupt
1495
1496	$signal = sig2num $signal;	1537	my $signal = sig2num $arg{signal};
1497	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1538	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1498		1539
1499	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1540	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1500	cb => sub { undef $SIG_EV{$signal} },	1541	cb => sub { undef $SIG_EV{$signal} },
1501	signal => $signal,	1542	signal => $signal,
1502	pipe => [$SIGPIPE_R->filenos],	1543	pipe => [$SIGPIPE_R->filenos],
1503	pipe_autodrain => 0,	1544	pipe_autodrain => 0,
1504	;	1545	;
1505		1546
1506	} else {	1547	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1548	}
		1549	: sub {
		1550	my (undef, %arg) = @_;
		1551
1507	# pure perl	1552	# pure perl
1508
1509	# AE::Util has been loaded in signal
1510	$signal = sig2name $signal;	1553	my $signal = sig2name $arg{signal};
1511	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1554	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1512		1555
1513	$SIG{$signal} \|\|= sub {	1556	$SIG{$signal} \|\|= sub {
1514	local $!;	1557	local $!;
1515	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1558	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1516	undef $SIG_EV{$signal};	1559	undef $SIG_EV{$signal};
1517	};	1560	};
1518		1561
1519	# can't do signal processing without introducing races in pure perl,	1562	# can't do signal processing without introducing races in pure perl,
1520	# so limit the signal latency.	1563	# so limit the signal latency.
1521	_sig_add;	1564	_sig_add;
1522	}
1523		1565
1524	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1566	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1567	}
1525	};	1568	;
1526		1569
1527	*AnyEvent::Base::signal::DESTROY = sub {	1570	*AnyEvent::Base::signal::DESTROY = sub {
1528	my ($signal, $cb) = @{$_[0]};	1571	my ($signal, $cb) = @{$_[0]};
1529		1572
1530	_sig_del;	1573	_sig_del;
…		…
1537	# print weird messages, or just unconditionally exit	1580	# print weird messages, or just unconditionally exit
1538	# instead of getting the default action.	1581	# instead of getting the default action.
1539	undef $SIG{$signal}	1582	undef $SIG{$signal}
1540	unless keys %{ $SIG_CB{$signal} };	1583	unless keys %{ $SIG_CB{$signal} };
1541	};	1584	};
		1585
		1586	*_signal_exec = sub {
		1587	$HAVE_ASYNC_INTERRUPT
		1588	? $SIGPIPE_R->drain
		1589	: sysread $SIGPIPE_R, (my $dummy), 9;
		1590
		1591	while (%SIG_EV) {
		1592	for (keys %SIG_EV) {
		1593	delete $SIG_EV{$_};
		1594	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1595	}
		1596	}
		1597	};
1542	};	1598	};
1543	die if $@;	1599	die if $@;
		1600
1544	&signal	1601	&signal
1545	}	1602	}
1546		1603
1547	# default implementation for ->child	1604	# default implementation for ->child
1548		1605
1549	our %PID_CB;	1606	our %PID_CB;
1550	our $CHLD_W;	1607	our $CHLD_W;
1551	our $CHLD_DELAY_W;	1608	our $CHLD_DELAY_W;
1552	our $WNOHANG;	1609	our $WNOHANG;
1553		1610
		1611	# used by many Impl's
1554	sub _emit_childstatus($$) {	1612	sub _emit_childstatus($$) {
1555	my (undef, $rpid, $rstatus) = @_;	1613	my (undef, $rpid, $rstatus) = @_;
1556		1614
1557	$_->($rpid, $rstatus)	1615	$_->($rpid, $rstatus)
1558	for values %{ $PID_CB{$rpid} \|\| {} },	1616	for values %{ $PID_CB{$rpid} \|\| {} },
1559	values %{ $PID_CB{0} \|\| {} };	1617	values %{ $PID_CB{0} \|\| {} };
1560	}	1618	}
1561		1619
1562	sub _sigchld {
1563	my $pid;
1564
1565	AnyEvent->_emit_childstatus ($pid, $?)
1566	while ($pid = waitpid -1, $WNOHANG) > 0;
1567	}
1568
1569	sub child {	1620	sub child {
		1621	eval q{ # poor man's autoloading {}
		1622	*_sigchld = sub {
		1623	my $pid;
		1624
		1625	AnyEvent->_emit_childstatus ($pid, $?)
		1626	while ($pid = waitpid -1, $WNOHANG) > 0;
		1627	};
		1628
		1629	*child = sub {
1570	my (undef, %arg) = @_;	1630	my (undef, %arg) = @_;
1571		1631
1572	defined (my $pid = $arg{pid} + 0)	1632	defined (my $pid = $arg{pid} + 0)
1573	or Carp::croak "required option 'pid' is missing";	1633	or Carp::croak "required option 'pid' is missing";
1574		1634
1575	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1635	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1576		1636
1577	# WNOHANG is almost cetrainly 1 everywhere	1637	# WNOHANG is almost cetrainly 1 everywhere
1578	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1638	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1579	? 1	1639	? 1
1580	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1640	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1581		1641
1582	unless ($CHLD_W) {	1642	unless ($CHLD_W) {
1583	$CHLD_W = AE::signal CHLD => \&_sigchld;	1643	$CHLD_W = AE::signal CHLD => \&_sigchld;
1584	# child could be a zombie already, so make at least one round	1644	# child could be a zombie already, so make at least one round
1585	&_sigchld;	1645	&_sigchld;
1586	}	1646	}
1587		1647
1588	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1648	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1589	}	1649	};
1590		1650
1591	sub AnyEvent::Base::child::DESTROY {	1651	*AnyEvent::Base::child::DESTROY = sub {
1592	my ($pid, $cb) = @{$_[0]};	1652	my ($pid, $cb) = @{$_[0]};
1593		1653
1594	delete $PID_CB{$pid}{$cb};	1654	delete $PID_CB{$pid}{$cb};
1595	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1655	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1596		1656
1597	undef $CHLD_W unless keys %PID_CB;	1657	undef $CHLD_W unless keys %PID_CB;
		1658	};
		1659	};
		1660	die if $@;
		1661
		1662	&child
1598	}	1663	}
1599		1664
1600	# idle emulation is done by simply using a timer, regardless	1665	# idle emulation is done by simply using a timer, regardless
1601	# of whether the process is idle or not, and not letting	1666	# of whether the process is idle or not, and not letting
1602	# the callback use more than 50% of the time.	1667	# the callback use more than 50% of the time.
1603	sub idle {	1668	sub idle {
		1669	eval q{ # poor man's autoloading {}
		1670	*idle = sub {
1604	my (undef, %arg) = @_;	1671	my (undef, %arg) = @_;
1605		1672
1606	my ($cb, $w, $rcb) = $arg{cb};	1673	my ($cb, $w, $rcb) = $arg{cb};
1607		1674
1608	$rcb = sub {	1675	$rcb = sub {
1609	if ($cb) {	1676	if ($cb) {
1610	$w = _time;	1677	$w = _time;
1611	&$cb;	1678	&$cb;
1612	$w = _time - $w;	1679	$w = _time - $w;
1613		1680
1614	# never use more then 50% of the time for the idle watcher,	1681	# never use more then 50% of the time for the idle watcher,
1615	# within some limits	1682	# within some limits
1616	$w = 0.0001 if $w < 0.0001;	1683	$w = 0.0001 if $w < 0.0001;
1617	$w = 5 if $w > 5;	1684	$w = 5 if $w > 5;
1618		1685
1619	$w = AE::timer $w, 0, $rcb;	1686	$w = AE::timer $w, 0, $rcb;
1620	} else {	1687	} else {
1621	# clean up...	1688	# clean up...
1622	undef $w;	1689	undef $w;
1623	undef $rcb;	1690	undef $rcb;
		1691	}
		1692	};
		1693
		1694	$w = AE::timer 0.05, 0, $rcb;
		1695
		1696	bless \\$cb, "AnyEvent::Base::idle"
1624	}	1697	};
		1698
		1699	*AnyEvent::Base::idle::DESTROY = sub {
		1700	undef $${$_[0]};
		1701	};
1625	};	1702	};
		1703	die if $@;
1626		1704
1627	$w = AE::timer 0.05, 0, $rcb;	1705	&idle
1628
1629	bless \\$cb, "AnyEvent::Base::idle"
1630	}
1631
1632	sub AnyEvent::Base::idle::DESTROY {
1633	undef $${$_[0]};
1634	}	1706	}
1635		1707
1636	package AnyEvent::CondVar;	1708	package AnyEvent::CondVar;
1637		1709
1638	our @ISA = AnyEvent::CondVar::Base::;	1710	our @ISA = AnyEvent::CondVar::Base::;
…		…
1997		2069
1998	The actual code goes further and collects all errors (C<die>s, exceptions)	2070	The actual code goes further and collects all errors (C<die>s, exceptions)
1999	that occurred during request processing. The C<result> method detects	2071	that occurred during request processing. The C<result> method detects
2000	whether an exception as thrown (it is stored inside the $txn object)	2072	whether an exception as thrown (it is stored inside the $txn object)
2001	and just throws the exception, which means connection errors and other	2073	and just throws the exception, which means connection errors and other
2002	problems get reported tot he code that tries to use the result, not in a	2074	problems get reported to the code that tries to use the result, not in a
2003	random callback.	2075	random callback.
2004		2076
2005	All of this enables the following usage styles:	2077	All of this enables the following usage styles:
2006		2078
2007	1. Blocking:	2079	1. Blocking:
…		…
2426	it's built-in modules) are required to use it.	2498	it's built-in modules) are required to use it.
2427		2499
2428	That does not mean that AnyEvent won't take advantage of some additional	2500	That does not mean that AnyEvent won't take advantage of some additional
2429	modules if they are installed.	2501	modules if they are installed.
2430		2502
2431	This section epxlains which additional modules will be used, and how they	2503	This section explains which additional modules will be used, and how they
2432	affect AnyEvent's operetion.	2504	affect AnyEvent's operation.
2433		2505
2434	=over 4	2506	=over 4
2435		2507
2436	=item L<Async::Interrupt>	2508	=item L<Async::Interrupt>
2437		2509
…		…
2442	catch the signals) with some delay (default is 10 seconds, look for	2514	catch the signals) with some delay (default is 10 seconds, look for
2443	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2515	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2444		2516
2445	If this module is available, then it will be used to implement signal	2517	If this module is available, then it will be used to implement signal
2446	catching, which means that signals will not be delayed, and the event loop	2518	catching, which means that signals will not be delayed, and the event loop
2447	will not be interrupted regularly, which is more efficient (And good for	2519	will not be interrupted regularly, which is more efficient (and good for
2448	battery life on laptops).	2520	battery life on laptops).
2449		2521
2450	This affects not just the pure-perl event loop, but also other event loops	2522	This affects not just the pure-perl event loop, but also other event loops
2451	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2523	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2452		2524
…		…
2464	automatic timer adjustments even when no monotonic clock is available,	2536	automatic timer adjustments even when no monotonic clock is available,
2465	can take avdantage of advanced kernel interfaces such as C<epoll> and	2537	can take avdantage of advanced kernel interfaces such as C<epoll> and
2466	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2538	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2467	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2539	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2468		2540
		2541	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2542	then this module will do nothing for you.
		2543
2469	=item L<Guard>	2544	=item L<Guard>
2470		2545
2471	The guard module, when used, will be used to implement	2546	The guard module, when used, will be used to implement
2472	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2547	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2473	lot less memory), but otherwise doesn't affect guard operation much. It is	2548	lot less memory), but otherwise doesn't affect guard operation much. It is
2474	purely used for performance.	2549	purely used for performance.
2475		2550
2476	=item L<JSON> and L<JSON::XS>	2551	=item L<JSON> and L<JSON::XS>
2477		2552
2478	One of these modules is required when you want to read or write JSON data	2553	One of these modules is required when you want to read or write JSON data
2479	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2554	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2480	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2555	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2481
2482	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2483	installed.
2484		2556
2485	=item L<Net::SSLeay>	2557	=item L<Net::SSLeay>
2486		2558
2487	Implementing TLS/SSL in Perl is certainly interesting, but not very	2559	Implementing TLS/SSL in Perl is certainly interesting, but not very
2488	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2560	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2499		2571
2500		2572
2501	=head1 FORK	2573	=head1 FORK
2502		2574
2503	Most event libraries are not fork-safe. The ones who are usually are	2575	Most event libraries are not fork-safe. The ones who are usually are
2504	because they rely on inefficient but fork-safe C<select> or C<poll>	2576	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2505	calls. Only L<EV> is fully fork-aware.	2577	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2578	are usually badly thought-out hacks that are incompatible with fork in
		2579	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2580	continue event-processing in both parent and child (or both, if you know
		2581	what you are doing).
		2582
		2583	This means that, in general, you cannot fork and do event processing in
		2584	the child if the event library was initialised before the fork (which
		2585	usually happens when the first AnyEvent watcher is created, or the library
		2586	is loaded).
2506		2587
2507	If you have to fork, you must either do so I<before> creating your first	2588	If you have to fork, you must either do so I<before> creating your first
2508	watcher OR you must not use AnyEvent at all in the child OR you must do	2589	watcher OR you must not use AnyEvent at all in the child OR you must do
2509	something completely out of the scope of AnyEvent.	2590	something completely out of the scope of AnyEvent.
		2591
		2592	The problem of doing event processing in the parent I<and> the child
		2593	is much more complicated: even for backends that I<are> fork-aware or
		2594	fork-safe, their behaviour is not usually what you want: fork clones all
		2595	watchers, that means all timers, I/O watchers etc. are active in both
		2596	parent and child, which is almost never what you want. USing C<exec>
		2597	to start worker children from some kind of manage rprocess is usually
		2598	preferred, because it is much easier and cleaner, at the expense of having
		2599	to have another binary.
2510		2600
2511		2601
2512	=head1 SECURITY CONSIDERATIONS	2602	=head1 SECURITY CONSIDERATIONS
2513		2603
2514	AnyEvent can be forced to load any event model via	2604	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.292 by root, Mon Sep 14 05:05:09 2009 UTC vs. Revision 1.323 by root, Thu May 20 21:22:20 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.292 by root, Mon Sep 14 05:05:09 2009 UTC vs.
Revision 1.323 by root, Thu May 20 21:22:20 2010 UTC