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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.345 by root, Fri Dec 31 04:50:44 2010 UTC vs.
Revision 1.364 by root, Mon Aug 15 12:56:53 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
1009	=back	1054	=back
1010		1055
1011	=head1 WHAT TO DO IN A MODULE	1056	=head1 WHAT TO DO IN A MODULE
1012		1057
1013	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1058	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	1091	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	1092	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.	1093	might choose the wrong one unless you load the correct one yourself.
1049		1094
1050	You can chose to use a pure-perl implementation by loading the	1095	You can chose to use a pure-perl implementation by loading the
1051	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1096	C<AnyEvent::Loop> module, which gives you similar behaviour
1052	everywhere, but letting AnyEvent chose the model is generally better.	1097	everywhere, but letting AnyEvent chose the model is generally better.
1053		1098
1054	=head2 MAINLOOP EMULATION	1099	=head2 MAINLOOP EMULATION
1055		1100
1056	Sometimes (often for short test scripts, or even standalone programs who	1101	Sometimes (often for short test scripts, or even standalone programs who
…		…
1151		1196
1152	package AnyEvent;	1197	package AnyEvent;
1153		1198
1154	# basically a tuned-down version of common::sense	1199	# basically a tuned-down version of common::sense
1155	sub common_sense {	1200	sub common_sense {
1156	# from common:.sense 3.3	1201	# from common:.sense 3.4
1157	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";	1202	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1158	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)	1203	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1159	$^H \|= 0x00000600;	1204	$^H \|= 0x00000600;
1160	}	1205	}
1161		1206
1162	BEGIN { AnyEvent::common_sense }	1207	BEGIN { AnyEvent::common_sense }
1163		1208
1164	use Carp ();	1209	use Carp ();
1165		1210
1166	our $VERSION = '5.3';	1211	our $VERSION = '6.01';
1167	our $MODEL;	1212	our $MODEL;
1168		1213
1169	our $AUTOLOAD;
1170	our @ISA;	1214	our @ISA;
1171		1215
1172	our @REGISTRY;	1216	our @REGISTRY;
1173		1217
1174	our $VERBOSE;	1218	our $VERBOSE;
…		…
1194	$PROTOCOL{$_} = ++$idx	1238	$PROTOCOL{$_} = ++$idx
1195	for reverse split /\s,\s/,	1239	for reverse split /\s,\s/,
1196	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1240	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1197	}	1241	}
1198		1242
		1243	our @post_detect;
		1244
		1245	sub post_detect(&) {
		1246	my ($cb) = @_;
		1247
		1248	push @post_detect, $cb;
		1249
		1250	defined wantarray
		1251	? bless \$cb, "AnyEvent::Util::postdetect"
		1252	: ()
		1253	}
		1254
		1255	sub AnyEvent::Util::postdetect::DESTROY {
		1256	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1257	}
		1258
		1259	our $POSTPONE_W;
		1260	our @POSTPONE;
		1261
		1262	sub _postpone_exec {
		1263	undef $POSTPONE_W;
		1264
		1265	&{ shift @POSTPONE }
		1266	while @POSTPONE;
		1267	}
		1268
		1269	sub postpone(&) {
		1270	push @POSTPONE, shift;
		1271
		1272	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1273
		1274	()
		1275	}
		1276
1199	my @models = (	1277	our @models = (
1200	[EV:: => AnyEvent::Impl::EV:: , 1],	1278	[EV:: => AnyEvent::Impl::EV:: , 1],
1201	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1279	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1202	# everything below here will not (normally) be autoprobed	1280	# everything below here will not (normally) be autoprobed
1203	# as the pureperl backend should work everywhere	1281	# as the pure perl backend should work everywhere
1204	# and is usually faster	1282	# and is usually faster
1205	[Event:: => AnyEvent::Impl::Event::, 1],	1283	[Event:: => AnyEvent::Impl::Event::, 1],
1206	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1284	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1207	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1285	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1286	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1287	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1288	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1289	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212	[Wx:: => AnyEvent::Impl::POE::],	1290	[Wx:: => AnyEvent::Impl::POE::],
1213	[Prima:: => AnyEvent::Impl::POE::],	1291	[Prima:: => AnyEvent::Impl::POE::],
1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1292	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1293	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1294	[FLTK:: => AnyEvent::Impl::FLTK2::],
1216	);	1295	);
1217		1296
1218	our %method = map +($_ => 1),	1297	our @isa_hook;
		1298
		1299	sub _isa_set {
		1300	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1301
		1302	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1303	for 1 .. $#pkg;
		1304
		1305	grep $_ && $_->[1], @isa_hook
		1306	and AE::_reset ();
		1307	}
		1308
		1309	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1310	sub _isa_hook($$;$) {
		1311	my ($i, $pkg, $reset_ae) = @_;
		1312
		1313	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1314
		1315	_isa_set;
		1316	}
		1317
		1318	# all autoloaded methods reserve the complete glob, not just the method slot.
		1319	# due to bugs in perls method cache implementation.
1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1320	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		1321
1237	sub detect() {	1322	sub detect() {
		1323	return $MODEL if $MODEL; # some programs keep references to detect
		1324
		1325	local $!; # for good measure
		1326	local $SIG{__DIE__}; # we use eval
		1327
1238	# free some memory	1328	# free some memory
1239	*detect = sub () { $MODEL };	1329	*detect = sub () { $MODEL };
		1330	# undef &func doesn't correctly update the method cache. grmbl.
		1331	# so we delete the whole glob. grmbl.
		1332	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1333	# a glob with an active sub. hrm. i hope it works, but perl is
		1334	# usually buggy in this department. sigh.
		1335	delete @{"AnyEvent::"}{@methods};
		1336	undef @methods;
1240		1337
1241	local $!; # for good measure
1242	local $SIG{__DIE__};
1243
1244	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1338	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245	my $model = "AnyEvent::Impl::$1";	1339	my $model = $1;
		1340	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246	if (eval "require $model") {	1341	if (eval "require $model") {
1247	$MODEL = $model;	1342	$MODEL = $model;
1248	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1343	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1249	} else {	1344	} else {
1250	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1345	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
…		…
1283	$MODEL	1378	$MODEL
1284	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1379	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1285	}	1380	}
1286	}	1381	}
1287		1382
1288	@models = (); # free probe data	1383	# free memory only needed for probing
		1384	undef @models;
		1385	undef @REGISTRY;
1289		1386
1290	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1387	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291	unshift @ISA, $MODEL;
1292		1388
1293	# now nuke some methods that are overridden by the backend.	1389	# now nuke some methods that are overridden by the backend.
1294	# SUPER is not allowed.	1390	# SUPER usage is not allowed in these.
1295	for (qw(time signal child idle)) {	1391	for (qw(time signal child idle)) {
1296	undef &{"AnyEvent::Base::$_"}	1392	undef &{"AnyEvent::Base::$_"}
1297	if defined &{"$MODEL\::$_"};	1393	if defined &{"$MODEL\::$_"};
1298	}	1394	}
1299		1395
		1396	_isa_set;
		1397
1300	if ($ENV{PERL_ANYEVENT_STRICT}) {	1398	if ($ENV{PERL_ANYEVENT_STRICT}) {
1301	eval { require AnyEvent::Strict };	1399	require AnyEvent::Strict;
1302	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303	if $@ && $VERBOSE;
1304	}	1400	}
1305		1401
		1402	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1403	require AnyEvent::Debug;
		1404	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1405	}
		1406
		1407	if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1408	require AnyEvent::Socket;
		1409	require AnyEvent::Debug;
		1410
		1411	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1412	$shell =~ s/\$\$/$$/g;
		1413
		1414	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1415	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1416	}
		1417
1306	(shift @post_detect)->() while @post_detect;	1418	(shift @post_detect)->() while @post_detect;
		1419	undef @post_detect;
1307		1420
1308	*post_detect = sub(&) {	1421	*post_detect = sub(&) {
1309	shift->();	1422	shift->();
1310		1423
1311	undef	1424	undef
1312	};	1425	};
1313		1426
1314	$MODEL	1427	$MODEL
1315	}	1428	}
1316		1429
1317	sub AUTOLOAD {	1430	for my $name (@methods) {
1318	(my $func = $AUTOLOAD) =~ s/.*://;	1431	*$name = sub {
1319
1320	$method{$func}
1321	or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323	detect;	1432	detect;
1324		1433	# we use goto because
1325	my $class = shift;	1434	# a) it makes the thunk more transparent
1326	$class->$func (@_);	1435	# b) it allows us to delete the thunk later
		1436	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1437	};
1327	}	1438	}
1328		1439
1329	# utility function to dup a filehandle. this is used by many backends	1440	# utility function to dup a filehandle. this is used by many backends
1330	# to support binding more than one watcher per filehandle (they usually	1441	# 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).	1442	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1355		1466
1356	package AE;	1467	package AE;
1357		1468
1358	our $VERSION = $AnyEvent::VERSION;	1469	our $VERSION = $AnyEvent::VERSION;
1359		1470
		1471	sub _reset() {
		1472	eval q{
1360	# fall back to the main API by default - backends and AnyEvent::Base	1473	# fall back to the main API by default - backends and AnyEvent::Base
1361	# implementations can overwrite these.	1474	# implementations can overwrite these.
1362		1475
1363	sub io($$$) {	1476	sub io($$$) {
1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1477	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365	}	1478	}
1366		1479
1367	sub timer($$$) {	1480	sub timer($$$) {
1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1481	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369	}	1482	}
1370		1483
1371	sub signal($$) {	1484	sub signal($$) {
1372	AnyEvent->signal (signal => $_[0], cb => $_[1])	1485	AnyEvent->signal (signal => $_[0], cb => $_[1])
1373	}	1486	}
1374		1487
1375	sub child($$) {	1488	sub child($$) {
1376	AnyEvent->child (pid => $_[0], cb => $_[1])	1489	AnyEvent->child (pid => $_[0], cb => $_[1])
1377	}	1490	}
1378		1491
1379	sub idle($) {	1492	sub idle($) {
1380	AnyEvent->idle (cb => $_[0])	1493	AnyEvent->idle (cb => $_[0]);
1381	}	1494	}
1382		1495
1383	sub cv(;&) {	1496	sub cv(;&) {
1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1497	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385	}	1498	}
1386		1499
1387	sub now() {	1500	sub now() {
1388	AnyEvent->now	1501	AnyEvent->now
1389	}	1502	}
1390		1503
1391	sub now_update() {	1504	sub now_update() {
1392	AnyEvent->now_update	1505	AnyEvent->now_update
1393	}	1506	}
1394		1507
1395	sub time() {	1508	sub time() {
1396	AnyEvent->time	1509	AnyEvent->time
		1510	}
		1511
		1512	*postpone = \&AnyEvent::postpone;
		1513	};
		1514	die if $@;
1397	}	1515	}
		1516
		1517	BEGIN { _reset }
1398		1518
1399	package AnyEvent::Base;	1519	package AnyEvent::Base;
1400		1520
1401	# default implementations for many methods	1521	# default implementations for many methods
1402		1522
1403	sub time {	1523	sub time {
1404	eval q{ # poor man's autoloading {}	1524	eval q{ # poor man's autoloading {}
1405	# probe for availability of Time::HiRes	1525	# probe for availability of Time::HiRes
1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1526	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1527	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
		1528	*time = sub { Time::HiRes::time () };
1408	*AE::time = \&Time::HiRes::time;	1529	*AE::time = \& Time::HiRes::time ;
1409	# if (eval "use POSIX (); (POSIX::times())...	1530	# if (eval "use POSIX (); (POSIX::times())...
1410	} else {	1531	} else {
1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1532	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
		1533	*time = sub { CORE::time };
1412	*AE::time = sub (){ time }; # epic fail	1534	*AE::time = sub (){ CORE::time };
1413	}	1535	}
1414		1536
1415	*time = sub { AE::time }; # different prototypes	1537	*now = \&time;
1416	};	1538	};
1417	die if $@;	1539	die if $@;
1418		1540
1419	&time	1541	&time
1420	}	1542	}
1421		1543
1422	*now = \&time;	1544	*now = \&time;
1423
1424	sub now_update { }	1545	sub now_update { }
1425		1546
		1547	sub _poll {
		1548	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1549	}
		1550
1426	# default implementation for ->condvar	1551	# default implementation for ->condvar
		1552	# in fact, the default should not be overwritten
1427		1553
1428	sub condvar {	1554	sub condvar {
1429	eval q{ # poor man's autoloading {}	1555	eval q{ # poor man's autoloading {}
1430	*condvar = sub {	1556	*condvar = sub {
1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1557	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1601	: sysread $SIGPIPE_R, (my $dummy), 9;	1727	: sysread $SIGPIPE_R, (my $dummy), 9;
1602		1728
1603	while (%SIG_EV) {	1729	while (%SIG_EV) {
1604	for (keys %SIG_EV) {	1730	for (keys %SIG_EV) {
1605	delete $SIG_EV{$_};	1731	delete $SIG_EV{$_};
1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1732	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1607	}	1733	}
1608	}	1734	}
1609	};	1735	};
1610	};	1736	};
1611	die if $@;	1737	die if $@;
…		…
1638	};	1764	};
1639		1765
1640	*child = sub {	1766	*child = sub {
1641	my (undef, %arg) = @_;	1767	my (undef, %arg) = @_;
1642		1768
1643	defined (my $pid = $arg{pid} + 0)	1769	my $pid = $arg{pid};
1644	or Carp::croak "required option 'pid' is missing";	1770	my $cb = $arg{cb};
1645		1771
1646	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1772	$PID_CB{$pid}{$cb+0} = $cb;
1647		1773
1648	unless ($CHLD_W) {	1774	unless ($CHLD_W) {
1649	$CHLD_W = AE::signal CHLD => \&_sigchld;	1775	$CHLD_W = AE::signal CHLD => \&_sigchld;
1650	# child could be a zombie already, so make at least one round	1776	# child could be a zombie already, so make at least one round
1651	&_sigchld;	1777	&_sigchld;
1652	}	1778	}
1653		1779
1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1780	bless [$pid, $cb+0], "AnyEvent::Base::child"
1655	};	1781	};
1656		1782
1657	*AnyEvent::Base::child::DESTROY = sub {	1783	*AnyEvent::Base::child::DESTROY = sub {
1658	my ($pid, $cb) = @{$_[0]};	1784	my ($pid, $icb) = @{$_[0]};
1659		1785
1660	delete $PID_CB{$pid}{$cb};	1786	delete $PID_CB{$pid}{$icb};
1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1787	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662		1788
1663	undef $CHLD_W unless keys %PID_CB;	1789	undef $CHLD_W unless keys %PID_CB;
1664	};	1790	};
1665	};	1791	};
…		…
1678		1804
1679	my ($cb, $w, $rcb) = $arg{cb};	1805	my ($cb, $w, $rcb) = $arg{cb};
1680		1806
1681	$rcb = sub {	1807	$rcb = sub {
1682	if ($cb) {	1808	if ($cb) {
1683	$w = _time;	1809	$w = AE::time;
1684	&$cb;	1810	&$cb;
1685	$w = _time - $w;	1811	$w = AE::time - $w;
1686		1812
1687	# never use more then 50% of the time for the idle watcher,	1813	# never use more then 50% of the time for the idle watcher,
1688	# within some limits	1814	# within some limits
1689	$w = 0.0001 if $w < 0.0001;	1815	$w = 0.0001 if $w < 0.0001;
1690	$w = 5 if $w > 5;	1816	$w = 5 if $w > 5;
…		…
1737		1863
1738	sub _send {	1864	sub _send {
1739	# nop	1865	# nop
1740	}	1866	}
1741		1867
		1868	sub _wait {
		1869	AnyEvent->_poll until $_[0]{_ae_sent};
		1870	}
		1871
1742	sub send {	1872	sub send {
1743	my $cv = shift;	1873	my $cv = shift;
1744	$cv->{_ae_sent} = [@_];	1874	$cv->{_ae_sent} = [@_];
1745	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1875	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746	$cv->_send;	1876	$cv->_send;
…		…
1753		1883
1754	sub ready {	1884	sub ready {
1755	$_[0]{_ae_sent}	1885	$_[0]{_ae_sent}
1756	}	1886	}
1757		1887
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 {	1888	sub recv {
		1889	unless ($_[0]{_ae_sent}) {
		1890	$WAITING
		1891	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1892
		1893	local $WAITING = 1;
1768	$_[0]->_wait;	1894	$_[0]->_wait;
		1895	}
1769		1896
1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1897	$_[0]{_ae_croak}
1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1898	and Carp::croak $_[0]{_ae_croak};
		1899
		1900	wantarray
		1901	? @{ $_[0]{_ae_sent} }
		1902	: $_[0]{_ae_sent}[0]
1772	}	1903	}
1773		1904
1774	sub cb {	1905	sub cb {
1775	my $cv = shift;	1906	my $cv = shift;
1776		1907
…		…
1792	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1923	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1793	}	1924	}
1794		1925
1795	# undocumented/compatibility with pre-3.4	1926	# undocumented/compatibility with pre-3.4
1796	*broadcast = \&send;	1927	*broadcast = \&send;
1797	*wait = \&_wait;	1928	*wait = \&recv;
1798		1929
1799	=head1 ERROR AND EXCEPTION HANDLING	1930	=head1 ERROR AND EXCEPTION HANDLING
1800		1931
1801	In general, AnyEvent does not do any error handling - it relies on the	1932	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	1933	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1854	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	1985	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	1986	>>, it is definitely recommended to keep it off in production. Keeping
1856	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1987	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857	can be very useful, however.	1988	can be very useful, however.
1858		1989
		1990	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		1991
		1992	If this env variable is set, then its contents will be interpreted by
		1993	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		1994	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		1995	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		1996
		1997	This takes place when the first watcher is created.
		1998
		1999	For example, to bind a debug shell on a unix domain socket in
		2000	F<< /tmp/debug<pid>.sock >>, you could use this:
		2001
		2002	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2003
		2004	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2005	systems.
		2006
		2007	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2008
		2009	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2010	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2011
1859	=item C<PERL_ANYEVENT_MODEL>	2012	=item C<PERL_ANYEVENT_MODEL>
1860		2013
1861	This can be used to specify the event model to be used by AnyEvent, before	2014	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	2015	auto detection and -probing kicks in.
1863	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2016
		2017	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2018	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,	2019	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	2020	event model backend. If it fails to load then AnyEvent will proceed with
1866	auto detection and -probing.	2021	auto detection and -probing.
1867		2022
1868	This functionality might change in future versions.	2023	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2024	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2025	the end of a string designates a module name and quotes it appropriately).
1869		2026
1870	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2027	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871	could start your program like this:	2028	could start your program like this:
1872		2029
1873	PERL_ANYEVENT_MODEL=Perl perl ...	2030	PERL_ANYEVENT_MODEL=Perl perl ...
1874		2031
1875	=item C<PERL_ANYEVENT_PROTOCOLS>	2032	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2265	(even when used without AnyEvent), but most event loops have acceptable	2422	(even when used without AnyEvent), but most event loops have acceptable
2266	performance with or without AnyEvent.	2423	performance with or without AnyEvent.
2267		2424
2268	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2425	=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	2426	the actual event loop, only with extremely fast event loops such as EV
2270	adds AnyEvent significant overhead.	2427	does AnyEvent add significant overhead.
2271		2428
2272	=item * You should avoid POE like the plague if you want performance or	2429	=item * You should avoid POE like the plague if you want performance or
2273	reasonable memory usage.	2430	reasonable memory usage.
2274		2431
2275	=back	2432	=back
…		…
2574		2731
2575	=item L<Time::HiRes>	2732	=item L<Time::HiRes>
2576		2733
2577	This module is part of perl since release 5.008. It will be used when the	2734	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	2735	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	2736	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580	try to use a monotonic clock for timing stability.	2737	try to use a monotonic clock for timing stability.
2581		2738
2582	=back	2739	=back
2583		2740
2584		2741
…		…
2652		2809
2653	FAQ: L<AnyEvent::FAQ>.	2810	FAQ: L<AnyEvent::FAQ>.
2654		2811
2655	Utility functions: L<AnyEvent::Util>.	2812	Utility functions: L<AnyEvent::Util>.
2656		2813
2657	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2814	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2815	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2659		2816
2660	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2817	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2818	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2819	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2820	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.345 by root, Fri Dec 31 04:50:44 2010 UTC vs. Revision 1.364 by root, Mon Aug 15 12:56:53 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.345 by root, Fri Dec 31 04:50:44 2010 UTC vs.
Revision 1.364 by root, Mon Aug 15 12:56:53 2011 UTC