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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.352 by root, Thu Aug 4 09:14:01 2011 UTC vs.
Revision 1.358 by root, Sat Aug 13 02:35:32 2011 UTC

…		…
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::FLTK based on FLTK.	883	AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
884		884
885	=item Backends with special needs.	885	=item Backends with special needs.
886		886
887	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
888	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
…		…
1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006	# as soon as it is	1006	# as soon as it is
1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008	}	1008	}
1009		1009
		1010	=item AnyEvent::postpone { BLOCK }
		1011
		1012	Arranges for the block to be executed as soon as possible, but not before
		1013	the call itself returns. In practise, the block will be executed just
		1014	before the event loop polls for new events, or shortly afterwards.
		1015
		1016	This function never returns anything (to make the C<return postpone { ...
		1017	}> idiom more useful.
		1018
		1019	To understand the usefulness of this function, consider a function that
		1020	asynchronously does something for you and returns some transaction
		1021	object or guard to let you cancel the operation. For example,
		1022	C<AnyEvent::Socket::tcp_connect>:
		1023
		1024	# start a conenction attempt unless one is active
		1025	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1026	delete $self->{connect_guard};
		1027	...
		1028	};
		1029
		1030	Imagine that this function could instantly call the callback, for
		1031	example, because it detects an obvious error such as a negative port
		1032	number. Invoking the callback before the function returns causes problems
		1033	however: the callback will be called and will try to delete the guard
		1034	object. But since the function hasn't returned yet, there is nothing to
		1035	delete. When the function eventually returns it will assign the guard
		1036	object to C<< $self->{connect_guard} >>, where it will likely never be
		1037	deleted, so the program thinks it is still trying to connect.
		1038
		1039	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1040	callback directly on error:
		1041
		1042	$cb->(undef), return # signal error to callback, BAD!
		1043	if $some_error_condition;
		1044
		1045	It should use C<postpone>:
		1046
		1047	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1048	if $some_error_condition;
		1049
1010	=back	1050	=back
1011		1051
1012	=head1 WHAT TO DO IN A MODULE	1052	=head1 WHAT TO DO IN A MODULE
1013		1053
1014	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1054	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1165	use Carp ();	1205	use Carp ();
1166		1206
1167	our $VERSION = '5.34';	1207	our $VERSION = '5.34';
1168	our $MODEL;	1208	our $MODEL;
1169		1209
1170	our $AUTOLOAD;
1171	our @ISA;	1210	our @ISA;
1172		1211
1173	our @REGISTRY;	1212	our @REGISTRY;
1174		1213
1175	our $VERBOSE;	1214	our $VERBOSE;
…		…
1195	$PROTOCOL{$_} = ++$idx	1234	$PROTOCOL{$_} = ++$idx
1196	for reverse split /\s,\s/,	1235	for reverse split /\s,\s/,
1197	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1236	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1198	}	1237	}
1199		1238
		1239	our @post_detect;
		1240
		1241	sub post_detect(&) {
		1242	my ($cb) = @_;
		1243
		1244	push @post_detect, $cb;
		1245
		1246	defined wantarray
		1247	? bless \$cb, "AnyEvent::Util::postdetect"
		1248	: ()
		1249	}
		1250
		1251	sub AnyEvent::Util::postdetect::DESTROY {
		1252	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1253	}
		1254
		1255	our $POSTPONE_W;
		1256	our @POSTPONE;
		1257
		1258	sub _postpone_exec {
		1259	undef $POSTPONE_W;
		1260
		1261	&{ shift @POSTPONE }
		1262	while @POSTPONE;
		1263	}
		1264
		1265	sub postpone(&) {
		1266	push @POSTPONE, shift;
		1267
		1268	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1269
		1270	()
		1271	}
		1272
1200	my @models = (	1273	our @models = (
1201	[EV:: => AnyEvent::Impl::EV:: , 1],	1274	[EV:: => AnyEvent::Impl::EV:: , 1],
1202	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],	1275	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1203	# everything below here will not (normally) be autoprobed	1276	# everything below here will not (normally) be autoprobed
1204	# as the pure perl backend should work everywhere	1277	# as the pure perl backend should work everywhere
1205	# and is usually faster	1278	# and is usually faster
…		…
1210	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1283	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1284	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1285	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213	[Wx:: => AnyEvent::Impl::POE::],	1286	[Wx:: => AnyEvent::Impl::POE::],
1214	[Prima:: => AnyEvent::Impl::POE::],	1287	[Prima:: => AnyEvent::Impl::POE::],
1215	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1288	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1289	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217	[FLTK:: => AnyEvent::Impl::FLTK::],	1290	[FLTK:: => AnyEvent::Impl::FLTK2::],
1218	);	1291	);
1219		1292
1220	our %method = map +($_ => 1),	1293	# all autoloaded methods reserve the complete glob, not just the method slot.
		1294	# due to bugs in perls method cache implementation.
1221	qw(io timer time now now_update signal child idle condvar DESTROY);	1295	our @methods = qw(io timer time now now_update signal child idle condvar);
1222
1223	our @post_detect;
1224
1225	sub post_detect(&) {
1226	my ($cb) = @_;
1227
1228	push @post_detect, $cb;
1229
1230	defined wantarray
1231	? bless \$cb, "AnyEvent::Util::postdetect"
1232	: ()
1233	}
1234
1235	sub AnyEvent::Util::postdetect::DESTROY {
1236	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1237	}
1238		1296
1239	sub detect() {	1297	sub detect() {
		1298	local $!; # for good measure
		1299	local $SIG{__DIE__}; # we use eval
		1300
1240	# free some memory	1301	# free some memory
1241	*detect = sub () { $MODEL };	1302	*detect = sub () { $MODEL };
		1303	# undef &func doesn't correctly update the method cache. grmbl.
		1304	# so we delete the whole glob. grmbl.
		1305	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1306	# a glob with an active sub. hrm. i hope it works, but perl is
		1307	# usually buggy in this department. sigh.
		1308	delete @{"AnyEvent::"}{@methods};
		1309	undef @methods;
1242		1310
1243	local $!; # for good measure
1244	local $SIG{__DIE__};
1245
1246	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1311	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247	my $model = "AnyEvent::Impl::$1";	1312	my $model = $1;
		1313	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248	if (eval "require $model") {	1314	if (eval "require $model") {
1249	$MODEL = $model;	1315	$MODEL = $model;
1250	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1316	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1251	} else {	1317	} else {
1252	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1318	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
…		…
1285	$MODEL	1351	$MODEL
1286	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1352	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1287	}	1353	}
1288	}	1354	}
1289		1355
1290	@models = (); # free probe data	1356	# free memory only needed for probing
		1357	undef @models;
		1358	undef @REGISTRY;
1291		1359
1292	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1360	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293	unshift @ISA, $MODEL;	1361	unshift @ISA, $MODEL;
1294		1362
1295	# now nuke some methods that are overridden by the backend.	1363	# now nuke some methods that are overridden by the backend.
1296	# SUPER is not allowed.	1364	# SUPER usage is not allowed in these.
1297	for (qw(time signal child idle)) {	1365	for (qw(time signal child idle)) {
1298	undef &{"AnyEvent::Base::$_"}	1366	undef &{"AnyEvent::Base::$_"}
1299	if defined &{"$MODEL\::$_"};	1367	if defined &{"$MODEL\::$_"};
1300	}	1368	}
1301		1369
1302	if ($ENV{PERL_ANYEVENT_STRICT}) {	1370	if ($ENV{PERL_ANYEVENT_STRICT}) {
1303	eval { require AnyEvent::Strict };	1371	require AnyEvent::Strict;
1304	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305	if $@ && $VERBOSE;
1306	}	1372	}
1307		1373
		1374	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1375	require AnyEvent::Debug;
		1376	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1377	}
		1378
		1379	if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1380	require AnyEvent::Socket;
		1381	require AnyEvent::Debug;
		1382
		1383	my ($host, $service) = AnyEvent::Socket::parse_hostport ($ENV{PERL_ANYEVENT_DEBUG_SHELL});
		1384	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1385	}
		1386
1308	(shift @post_detect)->() while @post_detect;	1387	(shift @post_detect)->() while @post_detect;
		1388	undef @post_detect;
1309		1389
1310	*post_detect = sub(&) {	1390	*post_detect = sub(&) {
1311	shift->();	1391	shift->();
1312		1392
1313	undef	1393	undef
1314	};	1394	};
1315		1395
1316	$MODEL	1396	$MODEL
1317	}	1397	}
1318		1398
1319	sub AUTOLOAD {	1399	for my $name (@methods) {
1320	(my $func = $AUTOLOAD) =~ s/.*://;	1400	*$name = sub {
1321
1322	$method{$func}
1323	or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325	detect;	1401	detect;
1326		1402	# we use goto because
1327	my $class = shift;	1403	# a) it makes the thunk more transparent
1328	$class->$func (@_);	1404	# b) it allows us to delete the thunk later
		1405	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1406	};
1329	}	1407	}
1330		1408
1331	# utility function to dup a filehandle. this is used by many backends	1409	# utility function to dup a filehandle. this is used by many backends
1332	# to support binding more than one watcher per filehandle (they usually	1410	# to support binding more than one watcher per filehandle (they usually
1333	# allow only one watcher per fd, so we dup it to get a different one).	1411	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1357		1435
1358	package AE;	1436	package AE;
1359		1437
1360	our $VERSION = $AnyEvent::VERSION;	1438	our $VERSION = $AnyEvent::VERSION;
1361		1439
		1440	sub _reset() {
		1441	eval q{
1362	# fall back to the main API by default - backends and AnyEvent::Base	1442	# fall back to the main API by default - backends and AnyEvent::Base
1363	# implementations can overwrite these.	1443	# implementations can overwrite these.
1364		1444
1365	sub io($$$) {	1445	sub io($$$) {
1366	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1446	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367	}	1447	}
1368		1448
1369	sub timer($$$) {	1449	sub timer($$$) {
1370	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1450	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371	}	1451	}
1372		1452
1373	sub signal($$) {	1453	sub signal($$) {
1374	AnyEvent->signal (signal => $_[0], cb => $_[1])	1454	AnyEvent->signal (signal => $_[0], cb => $_[1])
1375	}	1455	}
1376		1456
1377	sub child($$) {	1457	sub child($$) {
1378	AnyEvent->child (pid => $_[0], cb => $_[1])	1458	AnyEvent->child (pid => $_[0], cb => $_[1])
1379	}	1459	}
1380		1460
1381	sub idle($) {	1461	sub idle($) {
1382	AnyEvent->idle (cb => $_[0])	1462	AnyEvent->idle (cb => $_[0]);
1383	}	1463	}
1384		1464
1385	sub cv(;&) {	1465	sub cv(;&) {
1386	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1466	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387	}	1467	}
1388		1468
1389	sub now() {	1469	sub now() {
1390	AnyEvent->now	1470	AnyEvent->now
1391	}	1471	}
1392		1472
1393	sub now_update() {	1473	sub now_update() {
1394	AnyEvent->now_update	1474	AnyEvent->now_update
1395	}	1475	}
1396		1476
1397	sub time() {	1477	sub time() {
1398	AnyEvent->time	1478	AnyEvent->time
		1479	}
		1480
		1481	*postpone = \&AnyEvent::postpone;
		1482	};
		1483	die if $@;
1399	}	1484	}
		1485
		1486	BEGIN { _reset }
1400		1487
1401	package AnyEvent::Base;	1488	package AnyEvent::Base;
1402		1489
1403	# default implementations for many methods	1490	# default implementations for many methods
1404		1491
…		…
1428	sub _poll {	1515	sub _poll {
1429	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";	1516	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1430	}	1517	}
1431		1518
1432	# default implementation for ->condvar	1519	# default implementation for ->condvar
1433	# in fact,t he default should not be overwritten	1520	# in fact, the default should not be overwritten
1434		1521
1435	sub condvar {	1522	sub condvar {
1436	eval q{ # poor man's autoloading {}	1523	eval q{ # poor man's autoloading {}
1437	*condvar = sub {	1524	*condvar = sub {
1438	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1525	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1608	: sysread $SIGPIPE_R, (my $dummy), 9;	1695	: sysread $SIGPIPE_R, (my $dummy), 9;
1609		1696
1610	while (%SIG_EV) {	1697	while (%SIG_EV) {
1611	for (keys %SIG_EV) {	1698	for (keys %SIG_EV) {
1612	delete $SIG_EV{$_};	1699	delete $SIG_EV{$_};
1613	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1700	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1614	}	1701	}
1615	}	1702	}
1616	};	1703	};
1617	};	1704	};
1618	die if $@;	1705	die if $@;
…		…
1685		1772
1686	my ($cb, $w, $rcb) = $arg{cb};	1773	my ($cb, $w, $rcb) = $arg{cb};
1687		1774
1688	$rcb = sub {	1775	$rcb = sub {
1689	if ($cb) {	1776	if ($cb) {
1690	$w = _time;	1777	$w = AE::time;
1691	&$cb;	1778	&$cb;
1692	$w = _time - $w;	1779	$w = AE::time - $w;
1693		1780
1694	# never use more then 50% of the time for the idle watcher,	1781	# never use more then 50% of the time for the idle watcher,
1695	# within some limits	1782	# within some limits
1696	$w = 0.0001 if $w < 0.0001;	1783	$w = 0.0001 if $w < 0.0001;
1697	$w = 5 if $w > 5;	1784	$w = 5 if $w > 5;
…		…
1866	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	1953	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1867	>>, it is definitely recommended to keep it off in production. Keeping	1954	>>, it is definitely recommended to keep it off in production. Keeping
1868	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1955	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1869	can be very useful, however.	1956	can be very useful, however.
1870		1957
		1958	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		1959
		1960	If this env variable is set, then its contents will be
		1961	interpreted by C<AnyEvent::Socket::parse_hostport> and an
		1962	C<AnyEvent::Debug::shell> is bound on that port. The shell object is saved
		1963	in C<$AnyEvent::Debug::SHELL>.
		1964
		1965	For example, to bind a debug shell on a unix domain socket in
		1966	F</tmp/debug.sock>, you could use this:
		1967
		1968	PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug.sock perlprog
		1969
		1970	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		1971
		1972	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		1973	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		1974
1871	=item C<PERL_ANYEVENT_MODEL>	1975	=item C<PERL_ANYEVENT_MODEL>
1872		1976
1873	This can be used to specify the event model to be used by AnyEvent, before	1977	This can be used to specify the event model to be used by AnyEvent, before
1874	auto detection and -probing kicks in. It must be a string consisting	1978	auto detection and -probing kicks in.
1875	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1979
		1980	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		1981	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1876	and the resulting module name is loaded and if the load was successful,	1982	resulting module name is loaded and - if the load was successful - used as
1877	used as event model. If it fails to load AnyEvent will proceed with	1983	event model backend. If it fails to load then AnyEvent will proceed with
1878	auto detection and -probing.	1984	auto detection and -probing.
1879		1985
1880	This functionality might change in future versions.	1986	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		1987	nothing gets prepended and the module name is used as-is (hint: C<::> at
		1988	the end of a string designates a module name and quotes it appropriately).
1881		1989
1882	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you	1990	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1883	could start your program like this:	1991	could start your program like this:
1884		1992
1885	PERL_ANYEVENT_MODEL=Perl perl ...	1993	PERL_ANYEVENT_MODEL=Perl perl ...

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.352 by root, Thu Aug 4 09:14:01 2011 UTC vs. Revision 1.358 by root, Sat Aug 13 02:35:32 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.352 by root, Thu Aug 4 09:14:01 2011 UTC vs.
Revision 1.358 by root, Sat Aug 13 02:35:32 2011 UTC