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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.297 by root, Thu Nov 19 01:55:57 2009 UTC vs.
Revision 1.325 by root, Thu May 20 23:56:04 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 as part of 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.21';	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 $VERBOSE;	1160	our $VERBOSE;
1137		1161
1138	BEGIN {	1162	BEGIN {
1139	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1163	require "AnyEvent/constants.pl";
		1164
1140	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1165	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1141		1166
1142	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1167	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1143	if ${^TAINT};	1168	if ${^TAINT};
1144		1169
1145	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1170	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1188	our @post_detect;	1213	our @post_detect;
1189		1214
1190	sub post_detect(&) {	1215	sub post_detect(&) {
1191	my ($cb) = @_;	1216	my ($cb) = @_;
1192		1217
1193	if ($MODEL) {
1194	$cb->();
1195
1196	undef
1197	} else {
1198	push @post_detect, $cb;	1218	push @post_detect, $cb;
1199		1219
1200	defined wantarray	1220	defined wantarray
1201	? bless \$cb, "AnyEvent::Util::postdetect"	1221	? bless \$cb, "AnyEvent::Util::postdetect"
1202	: ()	1222	: ()
1203	}
1204	}	1223	}
1205		1224
1206	sub AnyEvent::Util::postdetect::DESTROY {	1225	sub AnyEvent::Util::postdetect::DESTROY {
1207	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1226	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1208	}	1227	}
1209		1228
1210	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
1211	unless ($MODEL) {	1247	unless ($MODEL) {
1212	local $SIG{__DIE__};	1248	for (@REGISTRY, @models) {
1213		1249	my ($package, $model) = @$_;
1214	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1250	if (${"$package\::VERSION"} > 0) {
1215	my $model = "AnyEvent::Impl::$1";
1216	if (eval "require $model") {	1251	if (eval "require $model") {
1217	$MODEL = $model;	1252	$MODEL = $model;
1218	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;
1219	} else {	1254	last;
1220	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1255	}
1221	}	1256	}
1222	}	1257	}
1223		1258
1224	# check for already loaded models
1225	unless ($MODEL) {	1259	unless ($MODEL) {
		1260	# try to autoload a model
1226	for (@REGISTRY, @models) {	1261	for (@REGISTRY, @models) {
1227	my ($package, $model) = @$_;	1262	my ($package, $model, $autoload) = @$_;
		1263	if (
		1264	$autoload
		1265	and eval "require $package"
1228	if (${"$package\::VERSION"} > 0) {	1266	and ${"$package\::VERSION"} > 0
1229	if (eval "require $model") {	1267	and eval "require $model"
		1268	) {
1230	$MODEL = $model;	1269	$MODEL = $model;
1231	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1270	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1232	last;	1271	last;
1233	}
1234	}	1272	}
1235	}	1273	}
1236		1274
1237	unless ($MODEL) {
1238	# try to autoload a model
1239	for (@REGISTRY, @models) {
1240	my ($package, $model, $autoload) = @$_;
1241	if (
1242	$autoload
1243	and eval "require $package"
1244	and ${"$package\::VERSION"} > 0
1245	and eval "require $model"
1246	) {
1247	$MODEL = $model;
1248	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1249	last;
1250	}
1251	}
1252
1253	$MODEL	1275	$MODEL
1254	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";
1255	}
1256	}	1277	}
1257
1258	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1259
1260	unshift @ISA, $MODEL;
1261
1262	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1263
1264	(shift @post_detect)->() while @post_detect;
1265	}	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	};
1266		1301
1267	$MODEL	1302	$MODEL
1268	}	1303	}
1269		1304
1270	sub AUTOLOAD {	1305	sub AUTOLOAD {
1271	(my $func = $AUTOLOAD) =~ s/.*://;	1306	(my $func = $AUTOLOAD) =~ s/.*://;
1272		1307
1273	$method{$func}	1308	$method{$func}
1274	or Carp::croak "$func: not a valid method for AnyEvent objects";	1309	or Carp::croak "$func: not a valid AnyEvent class method";
1275		1310
1276	detect unless $MODEL;	1311	detect;
1277		1312
1278	my $class = shift;	1313	my $class = shift;
1279	$class->$func (@_);	1314	$class->$func (@_);
1280	}	1315	}
1281		1316
…		…
1298		1333
1299	=head1 SIMPLIFIED AE API	1334	=head1 SIMPLIFIED AE API
1300		1335
1301	Starting with version 5.0, AnyEvent officially supports a second, much	1336	Starting with version 5.0, AnyEvent officially supports a second, much
1302	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
1303	overhead.	1338	overhead by using function call syntax and a fixed number of parameters.
1304		1339
1305	See the L<AE> manpage for details.	1340	See the L<AE> manpage for details.
1306		1341
1307	=cut	1342	=cut
1308		1343
1309	package AE;	1344	package AE;
1310		1345
1311	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.
1312		1350
1313	sub io($$$) {	1351	sub io($$$) {
1314	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1352	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1315	}	1353	}
1316		1354
…		…
1348		1386
1349	package AnyEvent::Base;	1387	package AnyEvent::Base;
1350		1388
1351	# default implementations for many methods	1389	# default implementations for many methods
1352		1390
1353	sub _time() {	1391	sub time {
		1392	eval q{ # poor man's autoloading {}
1354	# probe for availability of Time::HiRes	1393	# probe for availability of Time::HiRes
1355	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1394	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1356	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;
1357	*_time = \&Time::HiRes::time;	1396	*AE::time = \&Time::HiRes::time;
1358	# if (eval "use POSIX (); (POSIX::times())...	1397	# if (eval "use POSIX (); (POSIX::times())...
1359	} else {	1398	} else {
1360	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;
1361	*_time = sub { time }; # epic fail	1400	*AE::time = sub (){ time }; # epic fail
		1401	}
		1402
		1403	*time = sub { AE::time }; # different prototypes
1362	}	1404	};
		1405	die if $@;
1363		1406
1364	&_time	1407	&time
1365	}	1408	}
1366		1409
1367	sub time { _time }	1410	*now = \&time;
1368	sub now { _time }	1411
1369	sub now_update { }	1412	sub now_update { }
1370		1413
1371	# default implementation for ->condvar	1414	# default implementation for ->condvar
1372		1415
1373	sub condvar {	1416	sub condvar {
		1417	eval q{ # poor man's autoloading {}
		1418	*condvar = sub {
1374	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
1375	}	1429	}
1376		1430
1377	# default implementation for ->signal	1431	# default implementation for ->signal
1378		1432
1379	our $HAVE_ASYNC_INTERRUPT;	1433	our $HAVE_ASYNC_INTERRUPT;
…		…
1388		1442
1389	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1443	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1390	our (%SIG_ASY, %SIG_ASY_W);	1444	our (%SIG_ASY, %SIG_ASY_W);
1391	our ($SIG_COUNT, $SIG_TW);	1445	our ($SIG_COUNT, $SIG_TW);
1392		1446
1393	sub _signal_exec {
1394	$HAVE_ASYNC_INTERRUPT
1395	? $SIGPIPE_R->drain
1396	: sysread $SIGPIPE_R, (my $dummy), 9;
1397
1398	while (%SIG_EV) {
1399	for (keys %SIG_EV) {
1400	delete $SIG_EV{$_};
1401	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1402	}
1403	}
1404	}
1405
1406	# 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
1407	sub _sig_add() {	1449	sub _sig_add() {
1408	unless ($SIG_COUNT++) {	1450	unless ($SIG_COUNT++) {
1409	# try to align timer on a full-second boundary, if possible	1451	# try to align timer on a full-second boundary, if possible
1410	my $NOW = AE::now;	1452	my $NOW = AE::now;
1411		1453
…		…
1421	undef $SIG_TW	1463	undef $SIG_TW
1422	unless --$SIG_COUNT;	1464	unless --$SIG_COUNT;
1423	}	1465	}
1424		1466
1425	our $_sig_name_init; $_sig_name_init = sub {	1467	our $_sig_name_init; $_sig_name_init = sub {
1426	eval q{ # poor man's autoloading	1468	eval q{ # poor man's autoloading {}
1427	undef $_sig_name_init;	1469	undef $_sig_name_init;
1428		1470
1429	if (_have_async_interrupt) {	1471	if (_have_async_interrupt) {
1430	*sig2num = \&Async::Interrupt::sig2num;	1472	*sig2num = \&Async::Interrupt::sig2num;
1431	*sig2name = \&Async::Interrupt::sig2name;	1473	*sig2name = \&Async::Interrupt::sig2name;
…		…
1463	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1505	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1464		1506
1465	} else {	1507	} else {
1466	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;
1467		1509
1468	require Fcntl;
1469
1470	if (AnyEvent::WIN32) {	1510	if (AnyEvent::WIN32) {
1471	require AnyEvent::Util;	1511	require AnyEvent::Util;
1472		1512
1473	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1513	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1474	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1514	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1475	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
1476	} else {	1516	} else {
1477	pipe $SIGPIPE_R, $SIGPIPE_W;	1517	pipe $SIGPIPE_R, $SIGPIPE_W;
1478	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;
1479	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
1480		1520
1481	# 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...
1482	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1522	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1483	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1523	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1484	}	1524	}
1485		1525
1486	$SIGPIPE_R	1526	$SIGPIPE_R
1487	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";
1488		1528
1489	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1529	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1490	}	1530	}
1491		1531
1492	*signal = sub {	1532	*signal = $HAVE_ASYNC_INTERRUPT
		1533	? sub {
1493	my (undef, %arg) = @_;	1534	my (undef, %arg) = @_;
1494		1535
1495	my $signal = uc $arg{signal}
1496	or Carp::croak "required option 'signal' is missing";
1497
1498	if ($HAVE_ASYNC_INTERRUPT) {
1499	# async::interrupt	1536	# async::interrupt
1500
1501	$signal = sig2num $signal;	1537	my $signal = sig2num $arg{signal};
1502	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1538	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1503		1539
1504	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1540	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1505	cb => sub { undef $SIG_EV{$signal} },	1541	cb => sub { undef $SIG_EV{$signal} },
1506	signal => $signal,	1542	signal => $signal,
1507	pipe => [$SIGPIPE_R->filenos],	1543	pipe => [$SIGPIPE_R->filenos],
1508	pipe_autodrain => 0,	1544	pipe_autodrain => 0,
1509	;	1545	;
1510		1546
1511	} else {	1547	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1548	}
		1549	: sub {
		1550	my (undef, %arg) = @_;
		1551
1512	# pure perl	1552	# pure perl
1513
1514	# AE::Util has been loaded in signal
1515	$signal = sig2name $signal;	1553	my $signal = sig2name $arg{signal};
1516	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1554	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1517		1555
1518	$SIG{$signal} \|\|= sub {	1556	$SIG{$signal} \|\|= sub {
1519	local $!;	1557	local $!;
1520	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1558	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1521	undef $SIG_EV{$signal};	1559	undef $SIG_EV{$signal};
1522	};	1560	};
1523		1561
1524	# can't do signal processing without introducing races in pure perl,	1562	# can't do signal processing without introducing races in pure perl,
1525	# so limit the signal latency.	1563	# so limit the signal latency.
1526	_sig_add;	1564	_sig_add;
1527	}
1528		1565
1529	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1566	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1567	}
1530	};	1568	;
1531		1569
1532	*AnyEvent::Base::signal::DESTROY = sub {	1570	*AnyEvent::Base::signal::DESTROY = sub {
1533	my ($signal, $cb) = @{$_[0]};	1571	my ($signal, $cb) = @{$_[0]};
1534		1572
1535	_sig_del;	1573	_sig_del;
…		…
1542	# print weird messages, or just unconditionally exit	1580	# print weird messages, or just unconditionally exit
1543	# instead of getting the default action.	1581	# instead of getting the default action.
1544	undef $SIG{$signal}	1582	undef $SIG{$signal}
1545	unless keys %{ $SIG_CB{$signal} };	1583	unless keys %{ $SIG_CB{$signal} };
1546	};	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	};
1547	};	1598	};
1548	die if $@;	1599	die if $@;
		1600
1549	&signal	1601	&signal
1550	}	1602	}
1551		1603
1552	# default implementation for ->child	1604	# default implementation for ->child
1553		1605
1554	our %PID_CB;	1606	our %PID_CB;
1555	our $CHLD_W;	1607	our $CHLD_W;
1556	our $CHLD_DELAY_W;	1608	our $CHLD_DELAY_W;
1557	our $WNOHANG;	1609	our $WNOHANG;
1558		1610
		1611	# used by many Impl's
1559	sub _emit_childstatus($$) {	1612	sub _emit_childstatus($$) {
1560	my (undef, $rpid, $rstatus) = @_;	1613	my (undef, $rpid, $rstatus) = @_;
1561		1614
1562	$_->($rpid, $rstatus)	1615	$_->($rpid, $rstatus)
1563	for values %{ $PID_CB{$rpid} \|\| {} },	1616	for values %{ $PID_CB{$rpid} \|\| {} },
1564	values %{ $PID_CB{0} \|\| {} };	1617	values %{ $PID_CB{0} \|\| {} };
1565	}	1618	}
1566		1619
1567	sub _sigchld {
1568	my $pid;
1569
1570	AnyEvent->_emit_childstatus ($pid, $?)
1571	while ($pid = waitpid -1, $WNOHANG) > 0;
1572	}
1573
1574	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 {
1575	my (undef, %arg) = @_;	1630	my (undef, %arg) = @_;
1576		1631
1577	defined (my $pid = $arg{pid} + 0)	1632	defined (my $pid = $arg{pid} + 0)
1578	or Carp::croak "required option 'pid' is missing";	1633	or Carp::croak "required option 'pid' is missing";
1579		1634
1580	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1635	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1581		1636
1582	# WNOHANG is almost cetrainly 1 everywhere	1637	# WNOHANG is almost cetrainly 1 everywhere
1583	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1638	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1584	? 1	1639	? 1
1585	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1640	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1586		1641
1587	unless ($CHLD_W) {	1642	unless ($CHLD_W) {
1588	$CHLD_W = AE::signal CHLD => \&_sigchld;	1643	$CHLD_W = AE::signal CHLD => \&_sigchld;
1589	# 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
1590	&_sigchld;	1645	&_sigchld;
1591	}	1646	}
1592		1647
1593	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1648	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1594	}	1649	};
1595		1650
1596	sub AnyEvent::Base::child::DESTROY {	1651	*AnyEvent::Base::child::DESTROY = sub {
1597	my ($pid, $cb) = @{$_[0]};	1652	my ($pid, $cb) = @{$_[0]};
1598		1653
1599	delete $PID_CB{$pid}{$cb};	1654	delete $PID_CB{$pid}{$cb};
1600	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1655	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1601		1656
1602	undef $CHLD_W unless keys %PID_CB;	1657	undef $CHLD_W unless keys %PID_CB;
		1658	};
		1659	};
		1660	die if $@;
		1661
		1662	&child
1603	}	1663	}
1604		1664
1605	# idle emulation is done by simply using a timer, regardless	1665	# idle emulation is done by simply using a timer, regardless
1606	# of whether the process is idle or not, and not letting	1666	# of whether the process is idle or not, and not letting
1607	# the callback use more than 50% of the time.	1667	# the callback use more than 50% of the time.
1608	sub idle {	1668	sub idle {
		1669	eval q{ # poor man's autoloading {}
		1670	*idle = sub {
1609	my (undef, %arg) = @_;	1671	my (undef, %arg) = @_;
1610		1672
1611	my ($cb, $w, $rcb) = $arg{cb};	1673	my ($cb, $w, $rcb) = $arg{cb};
1612		1674
1613	$rcb = sub {	1675	$rcb = sub {
1614	if ($cb) {	1676	if ($cb) {
1615	$w = _time;	1677	$w = _time;
1616	&$cb;	1678	&$cb;
1617	$w = _time - $w;	1679	$w = _time - $w;
1618		1680
1619	# 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,
1620	# within some limits	1682	# within some limits
1621	$w = 0.0001 if $w < 0.0001;	1683	$w = 0.0001 if $w < 0.0001;
1622	$w = 5 if $w > 5;	1684	$w = 5 if $w > 5;
1623		1685
1624	$w = AE::timer $w, 0, $rcb;	1686	$w = AE::timer $w, 0, $rcb;
1625	} else {	1687	} else {
1626	# clean up...	1688	# clean up...
1627	undef $w;	1689	undef $w;
1628	undef $rcb;	1690	undef $rcb;
		1691	}
		1692	};
		1693
		1694	$w = AE::timer 0.05, 0, $rcb;
		1695
		1696	bless \\$cb, "AnyEvent::Base::idle"
1629	}	1697	};
		1698
		1699	*AnyEvent::Base::idle::DESTROY = sub {
		1700	undef $${$_[0]};
		1701	};
1630	};	1702	};
		1703	die if $@;
1631		1704
1632	$w = AE::timer 0.05, 0, $rcb;	1705	&idle
1633
1634	bless \\$cb, "AnyEvent::Base::idle"
1635	}
1636
1637	sub AnyEvent::Base::idle::DESTROY {
1638	undef $${$_[0]};
1639	}	1706	}
1640		1707
1641	package AnyEvent::CondVar;	1708	package AnyEvent::CondVar;
1642		1709
1643	our @ISA = AnyEvent::CondVar::Base::;	1710	our @ISA = AnyEvent::CondVar::Base::;
…		…
2002		2069
2003	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)
2004	that occurred during request processing. The C<result> method detects	2071	that occurred during request processing. The C<result> method detects
2005	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)
2006	and just throws the exception, which means connection errors and other	2073	and just throws the exception, which means connection errors and other
2007	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
2008	random callback.	2075	random callback.
2009		2076
2010	All of this enables the following usage styles:	2077	All of this enables the following usage styles:
2011		2078
2012	1. Blocking:	2079	1. Blocking:
…		…
2431	it's built-in modules) are required to use it.	2498	it's built-in modules) are required to use it.
2432		2499
2433	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
2434	modules if they are installed.	2501	modules if they are installed.
2435		2502
2436	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
2437	affect AnyEvent's operetion.	2504	affect AnyEvent's operation.
2438		2505
2439	=over 4	2506	=over 4
2440		2507
2441	=item L<Async::Interrupt>	2508	=item L<Async::Interrupt>
2442		2509
…		…
2447	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
2448	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2515	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2449		2516
2450	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
2451	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
2452	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
2453	battery life on laptops).	2520	battery life on laptops).
2454		2521
2455	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
2456	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).
2457		2524
…		…
2469	automatic timer adjustments even when no monotonic clock is available,	2536	automatic timer adjustments even when no monotonic clock is available,
2470	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
2471	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
2472	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>).
2473		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
2474	=item L<Guard>	2544	=item L<Guard>
2475		2545
2476	The guard module, when used, will be used to implement	2546	The guard module, when used, will be used to implement
2477	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
2478	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
2479	purely used for performance.	2549	purely used for performance.
2480		2550
2481	=item L<JSON> and L<JSON::XS>	2551	=item L<JSON> and L<JSON::XS>
2482		2552
2483	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
2484	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
2485	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.
2486
2487	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2488	installed.
2489		2556
2490	=item L<Net::SSLeay>	2557	=item L<Net::SSLeay>
2491		2558
2492	Implementing TLS/SSL in Perl is certainly interesting, but not very	2559	Implementing TLS/SSL in Perl is certainly interesting, but not very
2493	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2560	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2504		2571
2505		2572
2506	=head1 FORK	2573	=head1 FORK
2507		2574
2508	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
2509	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
2510	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).
2511		2587
2512	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
2513	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
2514	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.
2515		2600
2516		2601
2517	=head1 SECURITY CONSIDERATIONS	2602	=head1 SECURITY CONSIDERATIONS
2518		2603
2519	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.297 by root, Thu Nov 19 01:55:57 2009 UTC vs. Revision 1.325 by root, Thu May 20 23:56:04 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.297 by root, Thu Nov 19 01:55:57 2009 UTC vs.
Revision 1.325 by root, Thu May 20 23:56:04 2010 UTC