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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.296 by root, Tue Nov 17 01:19:49 2009 UTC vs.
Revision 1.324 by root, Thu May 20 23:55:51 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 => ...
…		…
402	correctly.	405	correctly.
403		406
404	Example: exit on SIGINT	407	Example: exit on SIGINT
405		408
406	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).
407		427
408	=head3 Signal Races, Delays and Workarounds	428	=head3 Signal Races, Delays and Workarounds
409		429
410	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
411	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
…		…
486		506
487	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
488		508
489	$w = AnyEvent->idle (cb => <callback>);	509	$w = AnyEvent->idle (cb => <callback>);
490		510
491	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
492	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.
493	"nothing better to do" is usually defined to be "no other events need
494	attention by the event loop".
495		513
496	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
497	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
498	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.
499		522
500	Most event loops unfortunately do not really support idle watchers (only	523	Unfortunately, most event loops do not really support idle watchers (only
501	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
502	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
503		526
504	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
505	program is otherwise idle:	528	program is otherwise idle:
…		…
586	eventually calls C<< -> send >>, and the "consumer side", which waits	609	eventually calls C<< -> send >>, and the "consumer side", which waits
587	for the send to occur.	610	for the send to occur.
588		611
589	Example: wait for a timer.	612	Example: wait for a timer.
590		613
591	# wait till the result is ready	614	# condition: "wait till the timer is fired"
592	my $result_ready = AnyEvent->condvar;	615	my $timer_fired = AnyEvent->condvar;
593		616
594	# do something such as adding a timer	617	# create the timer - we could wait for, say
595	# or socket watcher the calls $result_ready->send	618	# a handle becomign ready, or even an
596	# when the "result" is ready.	619	# AnyEvent::HTTP request to finish, but
597	# in this case, we simply use a timer:	620	# in this case, we simply use a timer:
598	my $w = AnyEvent->timer (	621	my $w = AnyEvent->timer (
599	after => 1,	622	after => 1,
600	cb => sub { $result_ready->send },	623	cb => sub { $timer_fired->send },
601	);	624	);
602		625
603	# this "blocks" (while handling events) till the callback	626	# this "blocks" (while handling events) till the callback
604	# calls ->send	627	# calls ->send
605	$result_ready->recv;	628	$timer_fired->recv;
606		629
607	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
608	variables are also callable directly.	631	variables are also callable directly.
609		632
610	my $done = AnyEvent->condvar;	633	my $done = AnyEvent->condvar;
…		…
949	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:
950	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
951	array will be ignored.	974	array will be ignored.
952		975
953	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	976	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
954	it,as it takes care of these details.	977	it, as it takes care of these details.
955		978
956	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
957	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
958	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
959	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	}
960		996
961	=back	997	=back
962		998
963	=head1 WHAT TO DO IN A MODULE	999	=head1 WHAT TO DO IN A MODULE
964		1000
…		…
1021	=head1 OTHER MODULES	1057	=head1 OTHER MODULES
1022		1058
1023	The following is a non-exhaustive list of additional modules that use	1059	The following is a non-exhaustive list of additional modules that use
1024	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1060	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1025	modules and other event loops in the same program. Some of the modules	1061	modules and other event loops in the same program. Some of the modules
1026	come with AnyEvent, most are available via CPAN.	1062	come with AnyEvent, the others are available via CPAN.
1027		1063
1028	=over 4	1064	=over 4
1029		1065
1030	=item L<AnyEvent::Util>	1066	=item L<AnyEvent::Util>
1031		1067
…		…
1046		1082
1047	=item L<AnyEvent::DNS>	1083	=item L<AnyEvent::DNS>
1048		1084
1049	Provides rich asynchronous DNS resolver capabilities.	1085	Provides rich asynchronous DNS resolver capabilities.
1050		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
1051	=item L<AnyEvent::HTTP>	1110	=item L<AnyEvent::DBI>
1052		1111
1053	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,
1054	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.
1055		1121
1056	=item L<AnyEvent::HTTPD>	1122	=item L<AnyEvent::HTTPD>
1057		1123
1058	Provides a simple web application server framework.	1124	A simple embedded webserver.
1059		1125
1060	=item L<AnyEvent::FastPing>	1126	=item L<AnyEvent::FastPing>
1061		1127
1062	The fastest ping in the west.	1128	The fastest ping in the west.
1063
1064	=item L<AnyEvent::DBI>
1065
1066	Executes L<DBI> requests asynchronously in a proxy process.
1067
1068	=item L<AnyEvent::AIO>
1069
1070	Truly asynchronous I/O, should be in the toolbox of every event
1071	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1072	together.
1073
1074	=item L<AnyEvent::BDB>
1075
1076	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1077	L<BDB> and AnyEvent together.
1078
1079	=item L<AnyEvent::GPSD>
1080
1081	A non-blocking interface to gpsd, a daemon delivering GPS information.
1082
1083	=item L<AnyEvent::IRC>
1084
1085	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1086
1087	=item L<AnyEvent::XMPP>
1088
1089	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1090	Net::XMPP2>.
1091
1092	=item L<AnyEvent::IGS>
1093
1094	A non-blocking interface to the Internet Go Server protocol (used by
1095	L<App::IGS>).
1096
1097	=item L<Net::FCP>
1098
1099	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1100	of AnyEvent.
1101
1102	=item L<Event::ExecFlow>
1103
1104	High level API for event-based execution flow control.
1105		1129
1106	=item L<Coro>	1130	=item L<Coro>
1107		1131
1108	Has special support for AnyEvent via L<Coro::AnyEvent>.	1132	Has special support for AnyEvent via L<Coro::AnyEvent>.
1109		1133
…		…
1114	package AnyEvent;	1138	package AnyEvent;
1115		1139
1116	# basically a tuned-down version of common::sense	1140	# basically a tuned-down version of common::sense
1117	sub common_sense {	1141	sub common_sense {
1118	# from common:.sense 1.0	1142	# from common:.sense 1.0
1119	${^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";
1120	# use strict vars subs	1144	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1121	$^H \|= 0x00000600;	1145	$^H \|= 0x00000600;
1122	}	1146	}
1123		1147
1124	BEGIN { AnyEvent::common_sense }	1148	BEGIN { AnyEvent::common_sense }
1125		1149
1126	use Carp ();	1150	use Carp ();
1127		1151
1128	our $VERSION = '5.202';	1152	our $VERSION = '5.261';
1129	our $MODEL;	1153	our $MODEL;
1130		1154
1131	our $AUTOLOAD;	1155	our $AUTOLOAD;
1132	our @ISA;	1156	our @ISA;
1133		1157
1134	our @REGISTRY;	1158	our @REGISTRY;
1135		1159
1136	our $WIN32;
1137
1138	our $VERBOSE;	1160	our $VERBOSE;
1139		1161
1140	BEGIN {	1162	BEGIN {
1141	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1163	require "AnyEvent/constants.pl";
		1164
1142	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1165	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1143		1166
1144	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1167	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1145	if ${^TAINT};	1168	if ${^TAINT};
1146		1169
1147	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1170	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1190	our @post_detect;	1213	our @post_detect;
1191		1214
1192	sub post_detect(&) {	1215	sub post_detect(&) {
1193	my ($cb) = @_;	1216	my ($cb) = @_;
1194		1217
1195	if ($MODEL) {
1196	$cb->();
1197
1198	undef
1199	} else {
1200	push @post_detect, $cb;	1218	push @post_detect, $cb;
1201		1219
1202	defined wantarray	1220	defined wantarray
1203	? bless \$cb, "AnyEvent::Util::postdetect"	1221	? bless \$cb, "AnyEvent::Util::postdetect"
1204	: ()	1222	: ()
1205	}
1206	}	1223	}
1207		1224
1208	sub AnyEvent::Util::postdetect::DESTROY {	1225	sub AnyEvent::Util::postdetect::DESTROY {
1209	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1226	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1210	}	1227	}
1211		1228
1212	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
1213	unless ($MODEL) {	1247	unless ($MODEL) {
1214	local $SIG{__DIE__};	1248	for (@REGISTRY, @models) {
1215		1249	my ($package, $model) = @$_;
1216	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1250	if (${"$package\::VERSION"} > 0) {
1217	my $model = "AnyEvent::Impl::$1";
1218	if (eval "require $model") {	1251	if (eval "require $model") {
1219	$MODEL = $model;	1252	$MODEL = $model;
1220	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;
1221	} else {	1254	last;
1222	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1255	}
1223	}	1256	}
1224	}	1257	}
1225		1258
1226	# check for already loaded models
1227	unless ($MODEL) {	1259	unless ($MODEL) {
		1260	# try to autoload a model
1228	for (@REGISTRY, @models) {	1261	for (@REGISTRY, @models) {
1229	my ($package, $model) = @$_;	1262	my ($package, $model, $autoload) = @$_;
		1263	if (
		1264	$autoload
		1265	and eval "require $package"
1230	if (${"$package\::VERSION"} > 0) {	1266	and ${"$package\::VERSION"} > 0
1231	if (eval "require $model") {	1267	and eval "require $model"
		1268	) {
1232	$MODEL = $model;	1269	$MODEL = $model;
1233	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1270	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1234	last;	1271	last;
1235	}
1236	}	1272	}
1237	}	1273	}
1238		1274
1239	unless ($MODEL) {
1240	# try to autoload a model
1241	for (@REGISTRY, @models) {
1242	my ($package, $model, $autoload) = @$_;
1243	if (
1244	$autoload
1245	and eval "require $package"
1246	and ${"$package\::VERSION"} > 0
1247	and eval "require $model"
1248	) {
1249	$MODEL = $model;
1250	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1251	last;
1252	}
1253	}
1254
1255	$MODEL	1275	$MODEL
1256	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";
1257	}
1258	}	1277	}
1259
1260	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1261
1262	unshift @ISA, $MODEL;
1263
1264	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1265
1266	(shift @post_detect)->() while @post_detect;
1267	}	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	};
1268		1301
1269	$MODEL	1302	$MODEL
1270	}	1303	}
1271		1304
1272	sub AUTOLOAD {	1305	sub AUTOLOAD {
1273	(my $func = $AUTOLOAD) =~ s/.*://;	1306	(my $func = $AUTOLOAD) =~ s/.*://;
1274		1307
1275	$method{$func}	1308	$method{$func}
1276	or Carp::croak "$func: not a valid method for AnyEvent objects";	1309	or Carp::croak "$func: not a valid AnyEvent class method";
1277		1310
1278	detect unless $MODEL;	1311	detect;
1279		1312
1280	my $class = shift;	1313	my $class = shift;
1281	$class->$func (@_);	1314	$class->$func (@_);
1282	}	1315	}
1283		1316
…		…
1300		1333
1301	=head1 SIMPLIFIED AE API	1334	=head1 SIMPLIFIED AE API
1302		1335
1303	Starting with version 5.0, AnyEvent officially supports a second, much	1336	Starting with version 5.0, AnyEvent officially supports a second, much
1304	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
1305	overhead.	1338	overhead by using function call syntax and a fixed number of parameters.
1306		1339
1307	See the L<AE> manpage for details.	1340	See the L<AE> manpage for details.
1308		1341
1309	=cut	1342	=cut
1310		1343
1311	package AE;	1344	package AE;
1312		1345
1313	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.
1314		1350
1315	sub io($$$) {	1351	sub io($$$) {
1316	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1352	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1317	}	1353	}
1318		1354
…		…
1350		1386
1351	package AnyEvent::Base;	1387	package AnyEvent::Base;
1352		1388
1353	# default implementations for many methods	1389	# default implementations for many methods
1354		1390
1355	sub _time() {	1391	sub time {
		1392	eval q{ # poor man's autoloading {}
1356	# probe for availability of Time::HiRes	1393	# probe for availability of Time::HiRes
1357	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1394	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1358	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;
1359	*_time = \&Time::HiRes::time;	1396	*AE::time = \&Time::HiRes::time;
1360	# if (eval "use POSIX (); (POSIX::times())...	1397	# if (eval "use POSIX (); (POSIX::times())...
1361	} else {	1398	} else {
1362	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;
1363	*_time = sub { time }; # epic fail	1400	*AE::time = sub (){ time }; # epic fail
		1401	}
		1402
		1403	*time = sub { AE::time }; # different prototypes
1364	}	1404	};
		1405	die if $@;
1365		1406
1366	&_time	1407	&time
1367	}	1408	}
1368		1409
1369	sub time { _time }	1410	*now = \&time;
1370	sub now { _time }	1411
1371	sub now_update { }	1412	sub now_update { }
1372		1413
1373	# default implementation for ->condvar	1414	# default implementation for ->condvar
1374		1415
1375	sub condvar {	1416	sub condvar {
		1417	eval q{ # poor man's autoloading {}
		1418	*condvar = sub {
1376	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
1377	}	1429	}
1378		1430
1379	# default implementation for ->signal	1431	# default implementation for ->signal
1380		1432
1381	our $HAVE_ASYNC_INTERRUPT;	1433	our $HAVE_ASYNC_INTERRUPT;
…		…
1390		1442
1391	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1443	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1392	our (%SIG_ASY, %SIG_ASY_W);	1444	our (%SIG_ASY, %SIG_ASY_W);
1393	our ($SIG_COUNT, $SIG_TW);	1445	our ($SIG_COUNT, $SIG_TW);
1394		1446
1395	sub _signal_exec {
1396	$HAVE_ASYNC_INTERRUPT
1397	? $SIGPIPE_R->drain
1398	: sysread $SIGPIPE_R, (my $dummy), 9;
1399
1400	while (%SIG_EV) {
1401	for (keys %SIG_EV) {
1402	delete $SIG_EV{$_};
1403	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1404	}
1405	}
1406	}
1407
1408	# 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
1409	sub _sig_add() {	1449	sub _sig_add() {
1410	unless ($SIG_COUNT++) {	1450	unless ($SIG_COUNT++) {
1411	# try to align timer on a full-second boundary, if possible	1451	# try to align timer on a full-second boundary, if possible
1412	my $NOW = AE::now;	1452	my $NOW = AE::now;
1413		1453
…		…
1423	undef $SIG_TW	1463	undef $SIG_TW
1424	unless --$SIG_COUNT;	1464	unless --$SIG_COUNT;
1425	}	1465	}
1426		1466
1427	our $_sig_name_init; $_sig_name_init = sub {	1467	our $_sig_name_init; $_sig_name_init = sub {
1428	eval q{ # poor man's autoloading	1468	eval q{ # poor man's autoloading {}
1429	undef $_sig_name_init;	1469	undef $_sig_name_init;
1430		1470
1431	if (_have_async_interrupt) {	1471	if (_have_async_interrupt) {
1432	*sig2num = \&Async::Interrupt::sig2num;	1472	*sig2num = \&Async::Interrupt::sig2num;
1433	*sig2name = \&Async::Interrupt::sig2name;	1473	*sig2name = \&Async::Interrupt::sig2name;
…		…
1465	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1505	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1466		1506
1467	} else {	1507	} else {
1468	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;
1469		1509
1470	require Fcntl;
1471
1472	if (AnyEvent::WIN32) {	1510	if (AnyEvent::WIN32) {
1473	require AnyEvent::Util;	1511	require AnyEvent::Util;
1474		1512
1475	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1513	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1476	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1514	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1477	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
1478	} else {	1516	} else {
1479	pipe $SIGPIPE_R, $SIGPIPE_W;	1517	pipe $SIGPIPE_R, $SIGPIPE_W;
1480	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;
1481	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
1482		1520
1483	# 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...
1484	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1522	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1485	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1523	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1486	}	1524	}
1487		1525
1488	$SIGPIPE_R	1526	$SIGPIPE_R
1489	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";
1490		1528
1491	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1529	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1492	}	1530	}
1493		1531
1494	*signal = sub {	1532	*signal = $HAVE_ASYNC_INTERRUPT
		1533	? sub {
1495	my (undef, %arg) = @_;	1534	my (undef, %arg) = @_;
1496		1535
1497	my $signal = uc $arg{signal}
1498	or Carp::croak "required option 'signal' is missing";
1499
1500	if ($HAVE_ASYNC_INTERRUPT) {
1501	# async::interrupt	1536	# async::interrupt
1502
1503	$signal = sig2num $signal;	1537	my $signal = sig2num $arg{signal};
1504	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1538	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1505		1539
1506	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1540	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1507	cb => sub { undef $SIG_EV{$signal} },	1541	cb => sub { undef $SIG_EV{$signal} },
1508	signal => $signal,	1542	signal => $signal,
1509	pipe => [$SIGPIPE_R->filenos],	1543	pipe => [$SIGPIPE_R->filenos],
1510	pipe_autodrain => 0,	1544	pipe_autodrain => 0,
1511	;	1545	;
1512		1546
1513	} else {	1547	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1548	}
		1549	: sub {
		1550	my (undef, %arg) = @_;
		1551
1514	# pure perl	1552	# pure perl
1515
1516	# AE::Util has been loaded in signal
1517	$signal = sig2name $signal;	1553	my $signal = sig2name $arg{signal};
1518	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1554	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1519		1555
1520	$SIG{$signal} \|\|= sub {	1556	$SIG{$signal} \|\|= sub {
1521	local $!;	1557	local $!;
1522	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1558	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1523	undef $SIG_EV{$signal};	1559	undef $SIG_EV{$signal};
1524	};	1560	};
1525		1561
1526	# can't do signal processing without introducing races in pure perl,	1562	# can't do signal processing without introducing races in pure perl,
1527	# so limit the signal latency.	1563	# so limit the signal latency.
1528	_sig_add;	1564	_sig_add;
1529	}
1530		1565
1531	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1566	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1567	}
1532	};	1568	;
1533		1569
1534	*AnyEvent::Base::signal::DESTROY = sub {	1570	*AnyEvent::Base::signal::DESTROY = sub {
1535	my ($signal, $cb) = @{$_[0]};	1571	my ($signal, $cb) = @{$_[0]};
1536		1572
1537	_sig_del;	1573	_sig_del;
…		…
1544	# print weird messages, or just unconditionally exit	1580	# print weird messages, or just unconditionally exit
1545	# instead of getting the default action.	1581	# instead of getting the default action.
1546	undef $SIG{$signal}	1582	undef $SIG{$signal}
1547	unless keys %{ $SIG_CB{$signal} };	1583	unless keys %{ $SIG_CB{$signal} };
1548	};	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	};
1549	};	1598	};
1550	die if $@;	1599	die if $@;
		1600
1551	&signal	1601	&signal
1552	}	1602	}
1553		1603
1554	# default implementation for ->child	1604	# default implementation for ->child
1555		1605
1556	our %PID_CB;	1606	our %PID_CB;
1557	our $CHLD_W;	1607	our $CHLD_W;
1558	our $CHLD_DELAY_W;	1608	our $CHLD_DELAY_W;
1559	our $WNOHANG;	1609	our $WNOHANG;
1560		1610
		1611	# used by many Impl's
1561	sub _emit_childstatus($$) {	1612	sub _emit_childstatus($$) {
1562	my (undef, $rpid, $rstatus) = @_;	1613	my (undef, $rpid, $rstatus) = @_;
1563		1614
1564	$_->($rpid, $rstatus)	1615	$_->($rpid, $rstatus)
1565	for values %{ $PID_CB{$rpid} \|\| {} },	1616	for values %{ $PID_CB{$rpid} \|\| {} },
1566	values %{ $PID_CB{0} \|\| {} };	1617	values %{ $PID_CB{0} \|\| {} };
1567	}	1618	}
1568		1619
1569	sub _sigchld {
1570	my $pid;
1571
1572	AnyEvent->_emit_childstatus ($pid, $?)
1573	while ($pid = waitpid -1, $WNOHANG) > 0;
1574	}
1575
1576	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 {
1577	my (undef, %arg) = @_;	1630	my (undef, %arg) = @_;
1578		1631
1579	defined (my $pid = $arg{pid} + 0)	1632	defined (my $pid = $arg{pid} + 0)
1580	or Carp::croak "required option 'pid' is missing";	1633	or Carp::croak "required option 'pid' is missing";
1581		1634
1582	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1635	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1583		1636
1584	# WNOHANG is almost cetrainly 1 everywhere	1637	# WNOHANG is almost cetrainly 1 everywhere
1585	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1638	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1586	? 1	1639	? 1
1587	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1640	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1588		1641
1589	unless ($CHLD_W) {	1642	unless ($CHLD_W) {
1590	$CHLD_W = AE::signal CHLD => \&_sigchld;	1643	$CHLD_W = AE::signal CHLD => \&_sigchld;
1591	# 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
1592	&_sigchld;	1645	&_sigchld;
1593	}	1646	}
1594		1647
1595	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1648	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1596	}	1649	};
1597		1650
1598	sub AnyEvent::Base::child::DESTROY {	1651	*AnyEvent::Base::child::DESTROY = sub {
1599	my ($pid, $cb) = @{$_[0]};	1652	my ($pid, $cb) = @{$_[0]};
1600		1653
1601	delete $PID_CB{$pid}{$cb};	1654	delete $PID_CB{$pid}{$cb};
1602	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1655	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1603		1656
1604	undef $CHLD_W unless keys %PID_CB;	1657	undef $CHLD_W unless keys %PID_CB;
		1658	};
		1659	};
		1660	die if $@;
		1661
		1662	&child
1605	}	1663	}
1606		1664
1607	# idle emulation is done by simply using a timer, regardless	1665	# idle emulation is done by simply using a timer, regardless
1608	# of whether the process is idle or not, and not letting	1666	# of whether the process is idle or not, and not letting
1609	# the callback use more than 50% of the time.	1667	# the callback use more than 50% of the time.
1610	sub idle {	1668	sub idle {
		1669	eval q{ # poor man's autoloading {}
		1670	*idle = sub {
1611	my (undef, %arg) = @_;	1671	my (undef, %arg) = @_;
1612		1672
1613	my ($cb, $w, $rcb) = $arg{cb};	1673	my ($cb, $w, $rcb) = $arg{cb};
1614		1674
1615	$rcb = sub {	1675	$rcb = sub {
1616	if ($cb) {	1676	if ($cb) {
1617	$w = _time;	1677	$w = _time;
1618	&$cb;	1678	&$cb;
1619	$w = _time - $w;	1679	$w = _time - $w;
1620		1680
1621	# 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,
1622	# within some limits	1682	# within some limits
1623	$w = 0.0001 if $w < 0.0001;	1683	$w = 0.0001 if $w < 0.0001;
1624	$w = 5 if $w > 5;	1684	$w = 5 if $w > 5;
1625		1685
1626	$w = AE::timer $w, 0, $rcb;	1686	$w = AE::timer $w, 0, $rcb;
1627	} else {	1687	} else {
1628	# clean up...	1688	# clean up...
1629	undef $w;	1689	undef $w;
1630	undef $rcb;	1690	undef $rcb;
		1691	}
		1692	};
		1693
		1694	$w = AE::timer 0.05, 0, $rcb;
		1695
		1696	bless \\$cb, "AnyEvent::Base::idle"
1631	}	1697	};
		1698
		1699	*AnyEvent::Base::idle::DESTROY = sub {
		1700	undef $${$_[0]};
		1701	};
1632	};	1702	};
		1703	die if $@;
1633		1704
1634	$w = AE::timer 0.05, 0, $rcb;	1705	&idle
1635
1636	bless \\$cb, "AnyEvent::Base::idle"
1637	}
1638
1639	sub AnyEvent::Base::idle::DESTROY {
1640	undef $${$_[0]};
1641	}	1706	}
1642		1707
1643	package AnyEvent::CondVar;	1708	package AnyEvent::CondVar;
1644		1709
1645	our @ISA = AnyEvent::CondVar::Base::;	1710	our @ISA = AnyEvent::CondVar::Base::;
…		…
2004		2069
2005	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)
2006	that occurred during request processing. The C<result> method detects	2071	that occurred during request processing. The C<result> method detects
2007	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)
2008	and just throws the exception, which means connection errors and other	2073	and just throws the exception, which means connection errors and other
2009	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
2010	random callback.	2075	random callback.
2011		2076
2012	All of this enables the following usage styles:	2077	All of this enables the following usage styles:
2013		2078
2014	1. Blocking:	2079	1. Blocking:
…		…
2433	it's built-in modules) are required to use it.	2498	it's built-in modules) are required to use it.
2434		2499
2435	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
2436	modules if they are installed.	2501	modules if they are installed.
2437		2502
2438	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
2439	affect AnyEvent's operetion.	2504	affect AnyEvent's operation.
2440		2505
2441	=over 4	2506	=over 4
2442		2507
2443	=item L<Async::Interrupt>	2508	=item L<Async::Interrupt>
2444		2509
…		…
2449	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
2450	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2515	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2451		2516
2452	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
2453	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
2454	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
2455	battery life on laptops).	2520	battery life on laptops).
2456		2521
2457	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
2458	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).
2459		2524
…		…
2471	automatic timer adjustments even when no monotonic clock is available,	2536	automatic timer adjustments even when no monotonic clock is available,
2472	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
2473	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
2474	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>).
2475		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
2476	=item L<Guard>	2544	=item L<Guard>
2477		2545
2478	The guard module, when used, will be used to implement	2546	The guard module, when used, will be used to implement
2479	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
2480	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
2481	purely used for performance.	2549	purely used for performance.
2482		2550
2483	=item L<JSON> and L<JSON::XS>	2551	=item L<JSON> and L<JSON::XS>
2484		2552
2485	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
2486	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
2487	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.
2488
2489	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2490	installed.
2491		2556
2492	=item L<Net::SSLeay>	2557	=item L<Net::SSLeay>
2493		2558
2494	Implementing TLS/SSL in Perl is certainly interesting, but not very	2559	Implementing TLS/SSL in Perl is certainly interesting, but not very
2495	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2560	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2506		2571
2507		2572
2508	=head1 FORK	2573	=head1 FORK
2509		2574
2510	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
2511	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
2512	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).
2513		2587
2514	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
2515	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
2516	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.
2517		2600
2518		2601
2519	=head1 SECURITY CONSIDERATIONS	2602	=head1 SECURITY CONSIDERATIONS
2520		2603
2521	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.296 by root, Tue Nov 17 01:19:49 2009 UTC vs. Revision 1.324 by root, Thu May 20 23:55:51 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.296 by root, Tue Nov 17 01:19:49 2009 UTC vs.
Revision 1.324 by root, Thu May 20 23:55:51 2010 UTC