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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs.
Revision 1.366 by root, Wed Aug 17 02:02:38 2011 UTC

…		…
121	The interface itself is vaguely similar, but not identical to the L<Event>	121	The interface itself is vaguely similar, but not identical to the L<Event>
122	module.	122	module.
123		123
124	During the first call of any watcher-creation method, the module tries	124	During the first call of any watcher-creation method, the module tries
125	to detect the currently loaded event loop by probing whether one of the	125	to detect the currently loaded event loop by probing whether one of the
126	following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
128	found is used. If none are detected, the module tries to load the first	128	found is used. If none are detected, the module tries to load the first
129	four modules in the order given; but note that if L<EV> is not	129	four modules in the order given; but note that if L<EV> is not
130	available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
131	the other two are not normally tried.	131	the other two are not normally tried.
132		132
133	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
134	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
135	that model the default. For example:	135	that model the default. For example:
…		…
142	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
143	starts using it, all bets are off - this case should be very rare though,	143	starts using it, all bets are off - this case should be very rare though,
144	as very few modules hardcode event loops without announcing this very	144	as very few modules hardcode event loops without announcing this very
145	loudly.	145	loudly.
146		146
147	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	other event modules you can load it explicitly and enjoy the high
149	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
150		150
151	=head1 WATCHERS	151	=head1 WATCHERS
152		152
153	AnyEvent has the central concept of a I<watcher>, which is an object that	153	AnyEvent has the central concept of a I<watcher>, which is an object that
154	stores relevant data for each kind of event you are waiting for, such as	154	stores relevant data for each kind of event you are waiting for, such as
…		…
356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357	account.	357	account.
358		358
359	=item AnyEvent->now_update	359	=item AnyEvent->now_update
360		360
361	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache	361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362	the current time for each loop iteration (see the discussion of L<<	362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363	AnyEvent->now >>, above).	363	above).
364		364
365	When a callback runs for a long time (or when the process sleeps), then	365	When a callback runs for a long time (or when the process sleeps), then
366	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
367	might affect timers and time-outs.	367	might affect timers and time-outs.
368		368
…		…
482	thing in an AnyEvent program, you I<have> to create at least one	482	thing in an AnyEvent program, you I<have> to create at least one
483	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
484	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
485		485
486	As most event loops do not support waiting for child events, they will be	486	As most event loops do not support waiting for child events, they will be
487	emulated by AnyEvent in most cases, in which the latency and race problems	487	emulated by AnyEvent in most cases, in which case the latency and race
488	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
489		489
490	Example: fork a process and wait for it	490	Example: fork a process and wait for it
491		491
492	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
493		493
…		…
860	use. If EV is not installed, then AnyEvent will fall back to its own	860	use. If EV is not installed, then AnyEvent will fall back to its own
861	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
862	AnyEvent itself.	862	AnyEvent itself.
863		863
864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866		866
867	=item Backends that are transparently being picked up when they are used.	867	=item Backends that are transparently being picked up when they are used.
868		868
869	These will be used if they are already loaded when the first watcher	869	These will be used if they are already loaded when the first watcher
870	is created, in which case it is assumed that the application is using	870	is created, in which case it is assumed that the application is using
…		…
878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
880	AnyEvent::Impl::Irssi used when running within irssi.	880	AnyEvent::Impl::Irssi used when running within irssi.
881	AnyEvent::Impl::IOAsync based on IO::Async.	881	AnyEvent::Impl::IOAsync based on IO::Async.
882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.	882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
883		884
884	=item Backends with special needs.	885	=item Backends with special needs.
885		886
886	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
887	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
…		…
932		933
933	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
934	if necessary. You should only call this function right before you would	935	if necessary. You should only call this function right before you would
935	have created an AnyEvent watcher anyway, that is, as late as possible at	936	have created an AnyEvent watcher anyway, that is, as late as possible at
936	runtime, and not e.g. during initialisation of your module.	937	runtime, and not e.g. during initialisation of your module.
		938
		939	The effect of calling this function is as if a watcher had been created
		940	(specifically, actions that happen "when the first watcher is created"
		941	happen when calling detetc as well).
937		942
938	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
939	created, use C<post_detect>.	944	created, use C<post_detect>.
940		945
941	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1004	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1005	# as soon as it is	1010	# as soon as it is
1006	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1007	}	1012	}
1008		1013
		1014	=item AnyEvent::postpone { BLOCK }
		1015
		1016	Arranges for the block to be executed as soon as possible, but not before
		1017	the call itself returns. In practise, the block will be executed just
		1018	before the event loop polls for new events, or shortly afterwards.
		1019
		1020	This function never returns anything (to make the C<return postpone { ...
		1021	}> idiom more useful.
		1022
		1023	To understand the usefulness of this function, consider a function that
		1024	asynchronously does something for you and returns some transaction
		1025	object or guard to let you cancel the operation. For example,
		1026	C<AnyEvent::Socket::tcp_connect>:
		1027
		1028	# start a conenction attempt unless one is active
		1029	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1030	delete $self->{connect_guard};
		1031	...
		1032	};
		1033
		1034	Imagine that this function could instantly call the callback, for
		1035	example, because it detects an obvious error such as a negative port
		1036	number. Invoking the callback before the function returns causes problems
		1037	however: the callback will be called and will try to delete the guard
		1038	object. But since the function hasn't returned yet, there is nothing to
		1039	delete. When the function eventually returns it will assign the guard
		1040	object to C<< $self->{connect_guard} >>, where it will likely never be
		1041	deleted, so the program thinks it is still trying to connect.
		1042
		1043	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1044	callback directly on error:
		1045
		1046	$cb->(undef), return # signal error to callback, BAD!
		1047	if $some_error_condition;
		1048
		1049	It should use C<postpone>:
		1050
		1051	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1052	if $some_error_condition;
		1053
		1054	=item AnyEvent::log $level, $msg[, @args]
		1055
		1056	Log the given C<$msg> at the given C<$level>.
		1057
		1058	Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
		1059	consequently, look at the L<AnyEvent::Log> documentation for details.
		1060
1009	=back	1061	=back
1010		1062
1011	=head1 WHAT TO DO IN A MODULE	1063	=head1 WHAT TO DO IN A MODULE
1012		1064
1013	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1065	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1046	modules might create watchers when they are loaded, and AnyEvent will	1098	modules might create watchers when they are loaded, and AnyEvent will
1047	decide on the event model to use as soon as it creates watchers, and it	1099	decide on the event model to use as soon as it creates watchers, and it
1048	might choose the wrong one unless you load the correct one yourself.	1100	might choose the wrong one unless you load the correct one yourself.
1049		1101
1050	You can chose to use a pure-perl implementation by loading the	1102	You can chose to use a pure-perl implementation by loading the
1051	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1103	C<AnyEvent::Loop> module, which gives you similar behaviour
1052	everywhere, but letting AnyEvent chose the model is generally better.	1104	everywhere, but letting AnyEvent chose the model is generally better.
1053		1105
1054	=head2 MAINLOOP EMULATION	1106	=head2 MAINLOOP EMULATION
1055		1107
1056	Sometimes (often for short test scripts, or even standalone programs who	1108	Sometimes (often for short test scripts, or even standalone programs who
…		…
1161		1213
1162	BEGIN { AnyEvent::common_sense }	1214	BEGIN { AnyEvent::common_sense }
1163		1215
1164	use Carp ();	1216	use Carp ();
1165		1217
1166	our $VERSION = '5.31';	1218	our $VERSION = '6.01';
1167	our $MODEL;	1219	our $MODEL;
1168		1220
1169	our $AUTOLOAD;
1170	our @ISA;	1221	our @ISA;
1171		1222
1172	our @REGISTRY;	1223	our @REGISTRY;
1173		1224
1174	our $VERBOSE;	1225	our $VERBOSE;
…		…
1180		1231
1181	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1232	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1182	if ${^TAINT};	1233	if ${^TAINT};
1183		1234
1184	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1235	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1185
1186	}	1236	}
1187		1237
1188	our $MAX_SIGNAL_LATENCY = 10;	1238	our $MAX_SIGNAL_LATENCY = 10;
1189		1239
1190	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1240	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1194	$PROTOCOL{$_} = ++$idx	1244	$PROTOCOL{$_} = ++$idx
1195	for reverse split /\s,\s/,	1245	for reverse split /\s,\s/,
1196	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1246	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1197	}	1247	}
1198		1248
		1249	our @post_detect;
		1250
		1251	sub post_detect(&) {
		1252	my ($cb) = @_;
		1253
		1254	push @post_detect, $cb;
		1255
		1256	defined wantarray
		1257	? bless \$cb, "AnyEvent::Util::postdetect"
		1258	: ()
		1259	}
		1260
		1261	sub AnyEvent::Util::postdetect::DESTROY {
		1262	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1263	}
		1264
		1265	our $POSTPONE_W;
		1266	our @POSTPONE;
		1267
		1268	sub _postpone_exec {
		1269	undef $POSTPONE_W;
		1270
		1271	&{ shift @POSTPONE }
		1272	while @POSTPONE;
		1273	}
		1274
		1275	sub postpone(&) {
		1276	push @POSTPONE, shift;
		1277
		1278	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1279
		1280	()
		1281	}
		1282
		1283	sub log($$;@) {
		1284	require AnyEvent::Log;
		1285	# AnyEvent::Log overwrites this function
		1286	goto &log;
		1287	}
		1288
1199	my @models = (	1289	our @models = (
1200	[EV:: => AnyEvent::Impl::EV:: , 1],	1290	[EV:: => AnyEvent::Impl::EV:: , 1],
1201	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1291	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1202	# everything below here will not (normally) be autoprobed	1292	# everything below here will not (normally) be autoprobed
1203	# as the pureperl backend should work everywhere	1293	# as the pure perl backend should work everywhere
1204	# and is usually faster	1294	# and is usually faster
1205	[Event:: => AnyEvent::Impl::Event::, 1],	1295	[Event:: => AnyEvent::Impl::Event::, 1],
1206	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1296	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1207	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1297	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1298	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1299	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1300	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1301	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212	[Wx:: => AnyEvent::Impl::POE::],	1302	[Wx:: => AnyEvent::Impl::POE::],
1213	[Prima:: => AnyEvent::Impl::POE::],	1303	[Prima:: => AnyEvent::Impl::POE::],
1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1304	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1305	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1306	[FLTK:: => AnyEvent::Impl::FLTK2::],
1216	);	1307	);
1217		1308
1218	our %method = map +($_ => 1),	1309	our @isa_hook;
		1310
		1311	sub _isa_set {
		1312	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1313
		1314	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1315	for 1 .. $#pkg;
		1316
		1317	grep $_ && $_->[1], @isa_hook
		1318	and AE::_reset ();
		1319	}
		1320
		1321	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1322	sub _isa_hook($$;$) {
		1323	my ($i, $pkg, $reset_ae) = @_;
		1324
		1325	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1326
		1327	_isa_set;
		1328	}
		1329
		1330	# all autoloaded methods reserve the complete glob, not just the method slot.
		1331	# due to bugs in perls method cache implementation.
1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1332	our @methods = qw(io timer time now now_update signal child idle condvar);
1220
1221	our @post_detect;
1222
1223	sub post_detect(&) {
1224	my ($cb) = @_;
1225
1226	push @post_detect, $cb;
1227
1228	defined wantarray
1229	? bless \$cb, "AnyEvent::Util::postdetect"
1230	: ()
1231	}
1232
1233	sub AnyEvent::Util::postdetect::DESTROY {
1234	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1235	}
1236		1333
1237	sub detect() {	1334	sub detect() {
		1335	return $MODEL if $MODEL; # some programs keep references to detect
		1336
		1337	local $!; # for good measure
		1338	local $SIG{__DIE__}; # we use eval
		1339
1238	# free some memory	1340	# free some memory
1239	*detect = sub () { $MODEL };	1341	*detect = sub () { $MODEL };
		1342	# undef &func doesn't correctly update the method cache. grmbl.
		1343	# so we delete the whole glob. grmbl.
		1344	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1345	# a glob with an active sub. hrm. i hope it works, but perl is
		1346	# usually buggy in this department. sigh.
		1347	delete @{"AnyEvent::"}{@methods};
		1348	undef @methods;
1240		1349
1241	local $!; # for good measure
1242	local $SIG{__DIE__};
1243
1244	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1350	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245	my $model = "AnyEvent::Impl::$1";	1351	my $model = $1;
		1352	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246	if (eval "require $model") {	1353	if (eval "require $model") {
1247	$MODEL = $model;	1354	$MODEL = $model;
1248	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1355	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
		1356	if $VERBOSE >= 7;
1249	} else {	1357	} else {
1250	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1358	AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1251	}	1359	}
1252	}	1360	}
1253		1361
1254	# check for already loaded models	1362	# check for already loaded models
1255	unless ($MODEL) {	1363	unless ($MODEL) {
1256	for (@REGISTRY, @models) {	1364	for (@REGISTRY, @models) {
1257	my ($package, $model) = @$_;	1365	my ($package, $model) = @$_;
1258	if (${"$package\::VERSION"} > 0) {	1366	if (${"$package\::VERSION"} > 0) {
1259	if (eval "require $model") {	1367	if (eval "require $model") {
1260	$MODEL = $model;	1368	$MODEL = $model;
1261	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1369	AnyEvent::log 7 => "autodetected model '$model', using it."
		1370	if $VERBOSE >= 7;
1262	last;	1371	last;
1263	}	1372	}
1264	}	1373	}
1265	}	1374	}
1266		1375
…		…
1273	and eval "require $package"	1382	and eval "require $package"
1274	and ${"$package\::VERSION"} > 0	1383	and ${"$package\::VERSION"} > 0
1275	and eval "require $model"	1384	and eval "require $model"
1276	) {	1385	) {
1277	$MODEL = $model;	1386	$MODEL = $model;
1278	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;	1387	AnyEvent::log 7 => "autoloaded model '$model', using it."
		1388	if $VERBOSE >= 7;
1279	last;	1389	last;
1280	}	1390	}
1281	}	1391	}
1282		1392
1283	$MODEL	1393	$MODEL
1284	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1394	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1285	}	1395	}
1286	}	1396	}
1287		1397
1288	@models = (); # free probe data	1398	# free memory only needed for probing
		1399	undef @models;
		1400	undef @REGISTRY;
1289		1401
1290	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1402	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291	unshift @ISA, $MODEL;
1292		1403
1293	# now nuke some methods that are overridden by the backend.	1404	# now nuke some methods that are overridden by the backend.
1294	# SUPER is not allowed.	1405	# SUPER usage is not allowed in these.
1295	for (qw(time signal child idle)) {	1406	for (qw(time signal child idle)) {
1296	undef &{"AnyEvent::Base::$_"}	1407	undef &{"AnyEvent::Base::$_"}
1297	if defined &{"$MODEL\::$_"};	1408	if defined &{"$MODEL\::$_"};
1298	}	1409	}
1299		1410
		1411	_isa_set;
		1412
1300	if ($ENV{PERL_ANYEVENT_STRICT}) {	1413	if ($ENV{PERL_ANYEVENT_STRICT}) {
1301	eval { require AnyEvent::Strict };	1414	require AnyEvent::Strict;
1302	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303	if $@ && $VERBOSE;
1304	}	1415	}
1305		1416
		1417	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1418	require AnyEvent::Debug;
		1419	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1420	}
		1421
		1422	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1423	require AnyEvent::Socket;
		1424	require AnyEvent::Debug;
		1425
		1426	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1427	$shell =~ s/\$\$/$$/g;
		1428
		1429	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1430	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1431	}
		1432
1306	(shift @post_detect)->() while @post_detect;	1433	(shift @post_detect)->() while @post_detect;
		1434	undef @post_detect;
1307		1435
1308	*post_detect = sub(&) {	1436	*post_detect = sub(&) {
1309	shift->();	1437	shift->();
1310		1438
1311	undef	1439	undef
1312	};	1440	};
1313		1441
1314	$MODEL	1442	$MODEL
1315	}	1443	}
1316		1444
1317	sub AUTOLOAD {	1445	for my $name (@methods) {
1318	(my $func = $AUTOLOAD) =~ s/.*://;	1446	*$name = sub {
1319
1320	$method{$func}
1321	or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323	detect;	1447	detect;
1324		1448	# we use goto because
1325	my $class = shift;	1449	# a) it makes the thunk more transparent
1326	$class->$func (@_);	1450	# b) it allows us to delete the thunk later
		1451	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1452	};
1327	}	1453	}
1328		1454
1329	# utility function to dup a filehandle. this is used by many backends	1455	# utility function to dup a filehandle. this is used by many backends
1330	# to support binding more than one watcher per filehandle (they usually	1456	# to support binding more than one watcher per filehandle (they usually
1331	# allow only one watcher per fd, so we dup it to get a different one).	1457	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1355		1481
1356	package AE;	1482	package AE;
1357		1483
1358	our $VERSION = $AnyEvent::VERSION;	1484	our $VERSION = $AnyEvent::VERSION;
1359		1485
		1486	sub _reset() {
		1487	eval q{
1360	# fall back to the main API by default - backends and AnyEvent::Base	1488	# fall back to the main API by default - backends and AnyEvent::Base
1361	# implementations can overwrite these.	1489	# implementations can overwrite these.
1362		1490
1363	sub io($$$) {	1491	sub io($$$) {
1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1492	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365	}	1493	}
1366		1494
1367	sub timer($$$) {	1495	sub timer($$$) {
1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1496	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369	}	1497	}
1370		1498
1371	sub signal($$) {	1499	sub signal($$) {
1372	AnyEvent->signal (signal => $_[0], cb => $_[1])	1500	AnyEvent->signal (signal => $_[0], cb => $_[1])
1373	}	1501	}
1374		1502
1375	sub child($$) {	1503	sub child($$) {
1376	AnyEvent->child (pid => $_[0], cb => $_[1])	1504	AnyEvent->child (pid => $_[0], cb => $_[1])
1377	}	1505	}
1378		1506
1379	sub idle($) {	1507	sub idle($) {
1380	AnyEvent->idle (cb => $_[0])	1508	AnyEvent->idle (cb => $_[0]);
1381	}	1509	}
1382		1510
1383	sub cv(;&) {	1511	sub cv(;&) {
1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1512	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385	}	1513	}
1386		1514
1387	sub now() {	1515	sub now() {
1388	AnyEvent->now	1516	AnyEvent->now
1389	}	1517	}
1390		1518
1391	sub now_update() {	1519	sub now_update() {
1392	AnyEvent->now_update	1520	AnyEvent->now_update
1393	}	1521	}
1394		1522
1395	sub time() {	1523	sub time() {
1396	AnyEvent->time	1524	AnyEvent->time
		1525	}
		1526
		1527	*postpone = \&AnyEvent::postpone;
		1528	*log = \&AnyEvent::log;
		1529	};
		1530	die if $@;
1397	}	1531	}
		1532
		1533	BEGIN { _reset }
1398		1534
1399	package AnyEvent::Base;	1535	package AnyEvent::Base;
1400		1536
1401	# default implementations for many methods	1537	# default implementations for many methods
1402		1538
1403	sub time {	1539	sub time {
1404	eval q{ # poor man's autoloading {}	1540	eval q{ # poor man's autoloading {}
1405	# probe for availability of Time::HiRes	1541	# probe for availability of Time::HiRes
1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1542	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1543	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
		1544	if $AnyEvent::VERBOSE >= 8;
		1545	*time = sub { Time::HiRes::time () };
1408	*AE::time = \&Time::HiRes::time;	1546	*AE::time = \& Time::HiRes::time ;
1409	# if (eval "use POSIX (); (POSIX::times())...	1547	# if (eval "use POSIX (); (POSIX::times())...
1410	} else {	1548	} else {
1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1549	AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
		1550	*time = sub { CORE::time };
1412	*AE::time = sub (){ time }; # epic fail	1551	*AE::time = sub (){ CORE::time };
1413	}	1552	}
1414		1553
1415	*time = sub { AE::time }; # different prototypes	1554	*now = \&time;
1416	};	1555	};
1417	die if $@;	1556	die if $@;
1418		1557
1419	&time	1558	&time
1420	}	1559	}
1421		1560
1422	*now = \&time;	1561	*now = \&time;
1423
1424	sub now_update { }	1562	sub now_update { }
1425		1563
		1564	sub _poll {
		1565	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1566	}
		1567
1426	# default implementation for ->condvar	1568	# default implementation for ->condvar
		1569	# in fact, the default should not be overwritten
1427		1570
1428	sub condvar {	1571	sub condvar {
1429	eval q{ # poor man's autoloading {}	1572	eval q{ # poor man's autoloading {}
1430	*condvar = sub {	1573	*condvar = sub {
1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1574	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1509		1652
1510	sub signal {	1653	sub signal {
1511	eval q{ # poor man's autoloading {}	1654	eval q{ # poor man's autoloading {}
1512	# probe for availability of Async::Interrupt	1655	# probe for availability of Async::Interrupt
1513	if (_have_async_interrupt) {	1656	if (_have_async_interrupt) {
1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1657	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
		1658	if $AnyEvent::VERBOSE >= 8;
1515		1659
1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1660	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1661	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1518		1662
1519	} else {	1663	} else {
1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1664	AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
		1665	if $AnyEvent::VERBOSE >= 8;
1521		1666
1522	if (AnyEvent::WIN32) {	1667	if (AnyEvent::WIN32) {
1523	require AnyEvent::Util;	1668	require AnyEvent::Util;
1524		1669
1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1670	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1601	: sysread $SIGPIPE_R, (my $dummy), 9;	1746	: sysread $SIGPIPE_R, (my $dummy), 9;
1602		1747
1603	while (%SIG_EV) {	1748	while (%SIG_EV) {
1604	for (keys %SIG_EV) {	1749	for (keys %SIG_EV) {
1605	delete $SIG_EV{$_};	1750	delete $SIG_EV{$_};
1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1751	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1607	}	1752	}
1608	}	1753	}
1609	};	1754	};
1610	};	1755	};
1611	die if $@;	1756	die if $@;
…		…
1638	};	1783	};
1639		1784
1640	*child = sub {	1785	*child = sub {
1641	my (undef, %arg) = @_;	1786	my (undef, %arg) = @_;
1642		1787
1643	defined (my $pid = $arg{pid} + 0)	1788	my $pid = $arg{pid};
1644	or Carp::croak "required option 'pid' is missing";	1789	my $cb = $arg{cb};
1645		1790
1646	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1791	$PID_CB{$pid}{$cb+0} = $cb;
1647		1792
1648	unless ($CHLD_W) {	1793	unless ($CHLD_W) {
1649	$CHLD_W = AE::signal CHLD => \&_sigchld;	1794	$CHLD_W = AE::signal CHLD => \&_sigchld;
1650	# child could be a zombie already, so make at least one round	1795	# child could be a zombie already, so make at least one round
1651	&_sigchld;	1796	&_sigchld;
1652	}	1797	}
1653		1798
1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1799	bless [$pid, $cb+0], "AnyEvent::Base::child"
1655	};	1800	};
1656		1801
1657	*AnyEvent::Base::child::DESTROY = sub {	1802	*AnyEvent::Base::child::DESTROY = sub {
1658	my ($pid, $cb) = @{$_[0]};	1803	my ($pid, $icb) = @{$_[0]};
1659		1804
1660	delete $PID_CB{$pid}{$cb};	1805	delete $PID_CB{$pid}{$icb};
1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1806	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662		1807
1663	undef $CHLD_W unless keys %PID_CB;	1808	undef $CHLD_W unless keys %PID_CB;
1664	};	1809	};
1665	};	1810	};
…		…
1678		1823
1679	my ($cb, $w, $rcb) = $arg{cb};	1824	my ($cb, $w, $rcb) = $arg{cb};
1680		1825
1681	$rcb = sub {	1826	$rcb = sub {
1682	if ($cb) {	1827	if ($cb) {
1683	$w = _time;	1828	$w = AE::time;
1684	&$cb;	1829	&$cb;
1685	$w = _time - $w;	1830	$w = AE::time - $w;
1686		1831
1687	# never use more then 50% of the time for the idle watcher,	1832	# never use more then 50% of the time for the idle watcher,
1688	# within some limits	1833	# within some limits
1689	$w = 0.0001 if $w < 0.0001;	1834	$w = 0.0001 if $w < 0.0001;
1690	$w = 5 if $w > 5;	1835	$w = 5 if $w > 5;
…		…
1737		1882
1738	sub _send {	1883	sub _send {
1739	# nop	1884	# nop
1740	}	1885	}
1741		1886
		1887	sub _wait {
		1888	AnyEvent->_poll until $_[0]{_ae_sent};
		1889	}
		1890
1742	sub send {	1891	sub send {
1743	my $cv = shift;	1892	my $cv = shift;
1744	$cv->{_ae_sent} = [@_];	1893	$cv->{_ae_sent} = [@_];
1745	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1894	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746	$cv->_send;	1895	$cv->_send;
…		…
1753		1902
1754	sub ready {	1903	sub ready {
1755	$_[0]{_ae_sent}	1904	$_[0]{_ae_sent}
1756	}	1905	}
1757		1906
1758	sub _wait {
1759	$WAITING
1760	and !$_[0]{_ae_sent}
1761	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1762
1763	local $WAITING = 1;
1764	AnyEvent->one_event while !$_[0]{_ae_sent};
1765	}
1766
1767	sub recv {	1907	sub recv {
		1908	unless ($_[0]{_ae_sent}) {
		1909	$WAITING
		1910	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1911
		1912	local $WAITING = 1;
1768	$_[0]->_wait;	1913	$_[0]->_wait;
		1914	}
1769		1915
1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1916	$_[0]{_ae_croak}
1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1917	and Carp::croak $_[0]{_ae_croak};
		1918
		1919	wantarray
		1920	? @{ $_[0]{_ae_sent} }
		1921	: $_[0]{_ae_sent}[0]
1772	}	1922	}
1773		1923
1774	sub cb {	1924	sub cb {
1775	my $cv = shift;	1925	my $cv = shift;
1776		1926
…		…
1792	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1942	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1793	}	1943	}
1794		1944
1795	# undocumented/compatibility with pre-3.4	1945	# undocumented/compatibility with pre-3.4
1796	*broadcast = \&send;	1946	*broadcast = \&send;
1797	*wait = \&_wait;	1947	*wait = \&recv;
1798		1948
1799	=head1 ERROR AND EXCEPTION HANDLING	1949	=head1 ERROR AND EXCEPTION HANDLING
1800		1950
1801	In general, AnyEvent does not do any error handling - it relies on the	1951	In general, AnyEvent does not do any error handling - it relies on the
1802	caller to do that if required. The L<AnyEvent::Strict> module (see also	1952	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1829		1979
1830	By default, AnyEvent will be completely silent except in fatal	1980	By default, AnyEvent will be completely silent except in fatal
1831	conditions. You can set this environment variable to make AnyEvent more	1981	conditions. You can set this environment variable to make AnyEvent more
1832	talkative.	1982	talkative.
1833		1983
1834	When set to C<1> or higher, causes AnyEvent to warn about unexpected	1984	When set to C<5> or higher, causes AnyEvent to warn about unexpected
1835	conditions, such as not being able to load the event model specified by	1985	conditions, such as not being able to load the event model specified by
1836	C<PERL_ANYEVENT_MODEL>.	1986	C<PERL_ANYEVENT_MODEL>.
1837		1987
1838	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1988	When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1839	model it chooses.	1989	model it chooses.
1840		1990
1841	When set to C<8> or higher, then AnyEvent will report extra information on	1991	When set to C<8> or higher, then AnyEvent will report extra information on
1842	which optional modules it loads and how it implements certain features.	1992	which optional modules it loads and how it implements certain features.
1843		1993
…		…
1854	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2004	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1855	>>, it is definitely recommended to keep it off in production. Keeping	2005	>>, it is definitely recommended to keep it off in production. Keeping
1856	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2006	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857	can be very useful, however.	2007	can be very useful, however.
1858		2008
		2009	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2010
		2011	If this env variable is set, then its contents will be interpreted by
		2012	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2013	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2014	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2015
		2016	This takes place when the first watcher is created.
		2017
		2018	For example, to bind a debug shell on a unix domain socket in
		2019	F<< /tmp/debug<pid>.sock >>, you could use this:
		2020
		2021	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2022
		2023	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2024	systems.
		2025
		2026	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2027
		2028	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2029	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2030
1859	=item C<PERL_ANYEVENT_MODEL>	2031	=item C<PERL_ANYEVENT_MODEL>
1860		2032
1861	This can be used to specify the event model to be used by AnyEvent, before	2033	This can be used to specify the event model to be used by AnyEvent, before
1862	auto detection and -probing kicks in. It must be a string consisting	2034	auto detection and -probing kicks in.
1863	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2035
		2036	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2037	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1864	and the resulting module name is loaded and if the load was successful,	2038	resulting module name is loaded and - if the load was successful - used as
1865	used as event model. If it fails to load AnyEvent will proceed with	2039	event model backend. If it fails to load then AnyEvent will proceed with
1866	auto detection and -probing.	2040	auto detection and -probing.
1867		2041
1868	This functionality might change in future versions.	2042	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2043	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2044	the end of a string designates a module name and quotes it appropriately).
1869		2045
1870	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2046	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871	could start your program like this:	2047	could start your program like this:
1872		2048
1873	PERL_ANYEVENT_MODEL=Perl perl ...	2049	PERL_ANYEVENT_MODEL=Perl perl ...
1874		2050
1875	=item C<PERL_ANYEVENT_PROTOCOLS>	2051	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2265	(even when used without AnyEvent), but most event loops have acceptable	2441	(even when used without AnyEvent), but most event loops have acceptable
2266	performance with or without AnyEvent.	2442	performance with or without AnyEvent.
2267		2443
2268	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2444	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2269	the actual event loop, only with extremely fast event loops such as EV	2445	the actual event loop, only with extremely fast event loops such as EV
2270	adds AnyEvent significant overhead.	2446	does AnyEvent add significant overhead.
2271		2447
2272	=item * You should avoid POE like the plague if you want performance or	2448	=item * You should avoid POE like the plague if you want performance or
2273	reasonable memory usage.	2449	reasonable memory usage.
2274		2450
2275	=back	2451	=back
…		…
2574		2750
2575	=item L<Time::HiRes>	2751	=item L<Time::HiRes>
2576		2752
2577	This module is part of perl since release 5.008. It will be used when the	2753	This module is part of perl since release 5.008. It will be used when the
2578	chosen event library does not come with a timing source of its own. The	2754	chosen event library does not come with a timing source of its own. The
2579	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2755	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580	try to use a monotonic clock for timing stability.	2756	try to use a monotonic clock for timing stability.
2581		2757
2582	=back	2758	=back
2583		2759
2584		2760
…		…
2650		2826
2651	Tutorial/Introduction: L<AnyEvent::Intro>.	2827	Tutorial/Introduction: L<AnyEvent::Intro>.
2652		2828
2653	FAQ: L<AnyEvent::FAQ>.	2829	FAQ: L<AnyEvent::FAQ>.
2654		2830
2655	Utility functions: L<AnyEvent::Util>.	2831	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2832	(simply logging).
2656		2833
2657	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2834	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2835	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2836
		2837	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2838	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2839	L<Qt>, L<POE>, L<FLTK>.
2659		2840
2660	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2841	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2842	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2843	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2844	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2845	L<AnyEvent::Impl::FLTK>.
2664		2846
2665	Non-blocking file handles, sockets, TCP clients and	2847	Non-blocking handles, pipes, stream sockets, TCP clients and
2666	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2848	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667		2849
2668	Asynchronous DNS: L<AnyEvent::DNS>.	2850	Asynchronous DNS: L<AnyEvent::DNS>.
2669		2851
2670	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2852	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs. Revision 1.366 by root, Wed Aug 17 02:02:38 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs.
Revision 1.366 by root, Wed Aug 17 02:02:38 2011 UTC