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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.350 by root, Tue Aug 2 20:02:44 2011 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::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
…		…
933		933
934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
935	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
936	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
937	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).
938		942
939	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
940	created, use C<post_detect>.	944	created, use C<post_detect>.
941		945
942	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006	# as soon as it is	1010	# as soon as it is
1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008	}	1012	}
1009		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
1010	=back	1054	=back
1011		1055
1012	=head1 WHAT TO DO IN A MODULE	1056	=head1 WHAT TO DO IN A MODULE
1013		1057
1014	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
…		…
1047	modules might create watchers when they are loaded, and AnyEvent will	1091	modules might create watchers when they are loaded, and AnyEvent will
1048	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
1049	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.
1050		1094
1051	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
1052	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1096	C<AnyEvent::Loop> module, which gives you similar behaviour
1053	everywhere, but letting AnyEvent chose the model is generally better.	1097	everywhere, but letting AnyEvent chose the model is generally better.
1054		1098
1055	=head2 MAINLOOP EMULATION	1099	=head2 MAINLOOP EMULATION
1056		1100
1057	Sometimes (often for short test scripts, or even standalone programs who	1101	Sometimes (often for short test scripts, or even standalone programs who
…		…
1162		1206
1163	BEGIN { AnyEvent::common_sense }	1207	BEGIN { AnyEvent::common_sense }
1164		1208
1165	use Carp ();	1209	use Carp ();
1166		1210
1167	our $VERSION = '5.34';	1211	our $VERSION = '6.01';
1168	our $MODEL;	1212	our $MODEL;
1169		1213
1170	our $AUTOLOAD;
1171	our @ISA;	1214	our @ISA;
1172		1215
1173	our @REGISTRY;	1216	our @REGISTRY;
1174		1217
1175	our $VERBOSE;	1218	our $VERBOSE;
…		…
1195	$PROTOCOL{$_} = ++$idx	1238	$PROTOCOL{$_} = ++$idx
1196	for reverse split /\s,\s/,	1239	for reverse split /\s,\s/,
1197	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1240	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1198	}	1241	}
1199		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
1200	my @models = (	1277	our @models = (
1201	[EV:: => AnyEvent::Impl::EV:: , 1],	1278	[EV:: => AnyEvent::Impl::EV:: , 1],
1202	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1279	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1203	# everything below here will not (normally) be autoprobed	1280	# everything below here will not (normally) be autoprobed
1204	# as the pureperl backend should work everywhere	1281	# as the pure perl backend should work everywhere
1205	# and is usually faster	1282	# and is usually faster
1206	[Event:: => AnyEvent::Impl::Event::, 1],	1283	[Event:: => AnyEvent::Impl::Event::, 1],
1207	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1284	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1208	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1285	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1286	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1210	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1287	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1288	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1289	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213	[Wx:: => AnyEvent::Impl::POE::],	1290	[Wx:: => AnyEvent::Impl::POE::],
1214	[Prima:: => AnyEvent::Impl::POE::],	1291	[Prima:: => AnyEvent::Impl::POE::],
1215	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1292	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1293	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217	[FLTK:: => AnyEvent::Impl::FLTK::],	1294	[FLTK:: => AnyEvent::Impl::FLTK2::],
1218	);	1295	);
1219		1296
1220	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.
1221	qw(io timer time now now_update signal child idle condvar DESTROY);	1320	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		1321
1239	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
1240	# free some memory	1328	# free some memory
1241	*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;
1242		1337
1243	local $!; # for good measure
1244	local $SIG{__DIE__};
1245
1246	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1338	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247	my $model = "AnyEvent::Impl::$1";	1339	my $model = $1;
		1340	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248	if (eval "require $model") {	1341	if (eval "require $model") {
1249	$MODEL = $model;	1342	$MODEL = $model;
1250	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;
1251	} else {	1344	} else {
1252	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;
…		…
1285	$MODEL	1378	$MODEL
1286	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";
1287	}	1380	}
1288	}	1381	}
1289		1382
1290	@models = (); # free probe data	1383	# free memory only needed for probing
		1384	undef @models;
		1385	undef @REGISTRY;
1291		1386
1292	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1387	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293	unshift @ISA, $MODEL;
1294		1388
1295	# now nuke some methods that are overridden by the backend.	1389	# now nuke some methods that are overridden by the backend.
1296	# SUPER is not allowed.	1390	# SUPER usage is not allowed in these.
1297	for (qw(time signal child idle)) {	1391	for (qw(time signal child idle)) {
1298	undef &{"AnyEvent::Base::$_"}	1392	undef &{"AnyEvent::Base::$_"}
1299	if defined &{"$MODEL\::$_"};	1393	if defined &{"$MODEL\::$_"};
1300	}	1394	}
1301		1395
		1396	_isa_set;
		1397
1302	if ($ENV{PERL_ANYEVENT_STRICT}) {	1398	if ($ENV{PERL_ANYEVENT_STRICT}) {
1303	eval { require AnyEvent::Strict };	1399	require AnyEvent::Strict;
1304	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305	if $@ && $VERBOSE;
1306	}	1400	}
1307		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
1308	(shift @post_detect)->() while @post_detect;	1418	(shift @post_detect)->() while @post_detect;
		1419	undef @post_detect;
1309		1420
1310	*post_detect = sub(&) {	1421	*post_detect = sub(&) {
1311	shift->();	1422	shift->();
1312		1423
1313	undef	1424	undef
1314	};	1425	};
1315		1426
1316	$MODEL	1427	$MODEL
1317	}	1428	}
1318		1429
1319	sub AUTOLOAD {	1430	for my $name (@methods) {
1320	(my $func = $AUTOLOAD) =~ s/.*://;	1431	*$name = sub {
1321
1322	$method{$func}
1323	or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325	detect;	1432	detect;
1326		1433	# we use goto because
1327	my $class = shift;	1434	# a) it makes the thunk more transparent
1328	$class->$func (@_);	1435	# b) it allows us to delete the thunk later
		1436	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1437	};
1329	}	1438	}
1330		1439
1331	# 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
1332	# to support binding more than one watcher per filehandle (they usually	1441	# 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).	1442	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1357		1466
1358	package AE;	1467	package AE;
1359		1468
1360	our $VERSION = $AnyEvent::VERSION;	1469	our $VERSION = $AnyEvent::VERSION;
1361		1470
		1471	sub _reset() {
		1472	eval q{
1362	# 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
1363	# implementations can overwrite these.	1474	# implementations can overwrite these.
1364		1475
1365	sub io($$$) {	1476	sub io($$$) {
1366	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1477	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367	}	1478	}
1368		1479
1369	sub timer($$$) {	1480	sub timer($$$) {
1370	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1481	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371	}	1482	}
1372		1483
1373	sub signal($$) {	1484	sub signal($$) {
1374	AnyEvent->signal (signal => $_[0], cb => $_[1])	1485	AnyEvent->signal (signal => $_[0], cb => $_[1])
1375	}	1486	}
1376		1487
1377	sub child($$) {	1488	sub child($$) {
1378	AnyEvent->child (pid => $_[0], cb => $_[1])	1489	AnyEvent->child (pid => $_[0], cb => $_[1])
1379	}	1490	}
1380		1491
1381	sub idle($) {	1492	sub idle($) {
1382	AnyEvent->idle (cb => $_[0])	1493	AnyEvent->idle (cb => $_[0]);
1383	}	1494	}
1384		1495
1385	sub cv(;&) {	1496	sub cv(;&) {
1386	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1497	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387	}	1498	}
1388		1499
1389	sub now() {	1500	sub now() {
1390	AnyEvent->now	1501	AnyEvent->now
1391	}	1502	}
1392		1503
1393	sub now_update() {	1504	sub now_update() {
1394	AnyEvent->now_update	1505	AnyEvent->now_update
1395	}	1506	}
1396		1507
1397	sub time() {	1508	sub time() {
1398	AnyEvent->time	1509	AnyEvent->time
		1510	}
		1511
		1512	*postpone = \&AnyEvent::postpone;
		1513	};
		1514	die if $@;
1399	}	1515	}
		1516
		1517	BEGIN { _reset }
1400		1518
1401	package AnyEvent::Base;	1519	package AnyEvent::Base;
1402		1520
1403	# default implementations for many methods	1521	# default implementations for many methods
1404		1522
1405	sub time {	1523	sub time {
1406	eval q{ # poor man's autoloading {}	1524	eval q{ # poor man's autoloading {}
1407	# probe for availability of Time::HiRes	1525	# probe for availability of Time::HiRes
1408	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1526	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1409	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 () };
1410	*AE::time = \&Time::HiRes::time;	1529	*AE::time = \& Time::HiRes::time ;
1411	# if (eval "use POSIX (); (POSIX::times())...	1530	# if (eval "use POSIX (); (POSIX::times())...
1412	} else {	1531	} else {
1413	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 };
1414	*AE::time = sub (){ time }; # epic fail	1534	*AE::time = sub (){ CORE::time };
1415	}	1535	}
1416		1536
1417	*time = sub { AE::time }; # different prototypes	1537	*now = \&time;
1418	};	1538	};
1419	die if $@;	1539	die if $@;
1420		1540
1421	&time	1541	&time
1422	}	1542	}
1423		1543
1424	*now = \&time;	1544	*now = \&time;
1425
1426	sub now_update { }	1545	sub now_update { }
1427		1546
		1547	sub _poll {
		1548	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1549	}
		1550
1428	# default implementation for ->condvar	1551	# default implementation for ->condvar
		1552	# in fact, the default should not be overwritten
1429		1553
1430	sub condvar {	1554	sub condvar {
1431	eval q{ # poor man's autoloading {}	1555	eval q{ # poor man's autoloading {}
1432	*condvar = sub {	1556	*condvar = sub {
1433	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1557	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1603	: sysread $SIGPIPE_R, (my $dummy), 9;	1727	: sysread $SIGPIPE_R, (my $dummy), 9;
1604		1728
1605	while (%SIG_EV) {	1729	while (%SIG_EV) {
1606	for (keys %SIG_EV) {	1730	for (keys %SIG_EV) {
1607	delete $SIG_EV{$_};	1731	delete $SIG_EV{$_};
1608	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1732	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1609	}	1733	}
1610	}	1734	}
1611	};	1735	};
1612	};	1736	};
1613	die if $@;	1737	die if $@;
…		…
1640	};	1764	};
1641		1765
1642	*child = sub {	1766	*child = sub {
1643	my (undef, %arg) = @_;	1767	my (undef, %arg) = @_;
1644		1768
1645	defined (my $pid = $arg{pid} + 0)	1769	my $pid = $arg{pid};
1646	or Carp::croak "required option 'pid' is missing";	1770	my $cb = $arg{cb};
1647		1771
1648	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1772	$PID_CB{$pid}{$cb+0} = $cb;
1649		1773
1650	unless ($CHLD_W) {	1774	unless ($CHLD_W) {
1651	$CHLD_W = AE::signal CHLD => \&_sigchld;	1775	$CHLD_W = AE::signal CHLD => \&_sigchld;
1652	# 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
1653	&_sigchld;	1777	&_sigchld;
1654	}	1778	}
1655		1779
1656	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1780	bless [$pid, $cb+0], "AnyEvent::Base::child"
1657	};	1781	};
1658		1782
1659	*AnyEvent::Base::child::DESTROY = sub {	1783	*AnyEvent::Base::child::DESTROY = sub {
1660	my ($pid, $cb) = @{$_[0]};	1784	my ($pid, $icb) = @{$_[0]};
1661		1785
1662	delete $PID_CB{$pid}{$cb};	1786	delete $PID_CB{$pid}{$icb};
1663	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1787	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1664		1788
1665	undef $CHLD_W unless keys %PID_CB;	1789	undef $CHLD_W unless keys %PID_CB;
1666	};	1790	};
1667	};	1791	};
…		…
1680		1804
1681	my ($cb, $w, $rcb) = $arg{cb};	1805	my ($cb, $w, $rcb) = $arg{cb};
1682		1806
1683	$rcb = sub {	1807	$rcb = sub {
1684	if ($cb) {	1808	if ($cb) {
1685	$w = _time;	1809	$w = AE::time;
1686	&$cb;	1810	&$cb;
1687	$w = _time - $w;	1811	$w = AE::time - $w;
1688		1812
1689	# 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,
1690	# within some limits	1814	# within some limits
1691	$w = 0.0001 if $w < 0.0001;	1815	$w = 0.0001 if $w < 0.0001;
1692	$w = 5 if $w > 5;	1816	$w = 5 if $w > 5;
…		…
1740	sub _send {	1864	sub _send {
1741	# nop	1865	# nop
1742	}	1866	}
1743		1867
1744	sub _wait {	1868	sub _wait {
1745	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";	1869	AnyEvent->_poll until $_[0]{_ae_sent};
1746	}	1870	}
1747		1871
1748	sub send {	1872	sub send {
1749	my $cv = shift;	1873	my $cv = shift;
1750	$cv->{_ae_sent} = [@_];	1874	$cv->{_ae_sent} = [@_];
…		…
1762	}	1886	}
1763		1887
1764	sub recv {	1888	sub recv {
1765	unless ($_[0]{_ae_sent}) {	1889	unless ($_[0]{_ae_sent}) {
1766	$WAITING	1890	$WAITING
1767	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";	1891	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1768		1892
1769	local $WAITING = 1;	1893	local $WAITING = 1;
1770	$_[0]->_wait;	1894	$_[0]->_wait;
1771	}	1895	}
1772		1896
…		…
1861	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>
1862	>>, it is definitely recommended to keep it off in production. Keeping	1986	>>, it is definitely recommended to keep it off in production. Keeping
1863	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1987	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1864	can be very useful, however.	1988	can be very useful, however.
1865		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
1866	=item C<PERL_ANYEVENT_MODEL>	2012	=item C<PERL_ANYEVENT_MODEL>
1867		2013
1868	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
1869	auto detection and -probing kicks in. It must be a string consisting	2015	auto detection and -probing kicks in.
1870	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
1871	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
1872	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
1873	auto detection and -probing.	2021	auto detection and -probing.
1874		2022
1875	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).
1876		2026
1877	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
1878	could start your program like this:	2028	could start your program like this:
1879		2029
1880	PERL_ANYEVENT_MODEL=Perl perl ...	2030	PERL_ANYEVENT_MODEL=Perl perl ...
1881		2031
1882	=item C<PERL_ANYEVENT_PROTOCOLS>	2032	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2272	(even when used without AnyEvent), but most event loops have acceptable	2422	(even when used without AnyEvent), but most event loops have acceptable
2273	performance with or without AnyEvent.	2423	performance with or without AnyEvent.
2274		2424
2275	=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
2276	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
2277	adds AnyEvent significant overhead.	2427	does AnyEvent add significant overhead.
2278		2428
2279	=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
2280	reasonable memory usage.	2430	reasonable memory usage.
2281		2431
2282	=back	2432	=back
…		…
2581		2731
2582	=item L<Time::HiRes>	2732	=item L<Time::HiRes>
2583		2733
2584	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
2585	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
2586	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
2587	try to use a monotonic clock for timing stability.	2737	try to use a monotonic clock for timing stability.
2588		2738
2589	=back	2739	=back
2590		2740
2591		2741
…		…
2659		2809
2660	FAQ: L<AnyEvent::FAQ>.	2810	FAQ: L<AnyEvent::FAQ>.
2661		2811
2662	Utility functions: L<AnyEvent::Util>.	2812	Utility functions: L<AnyEvent::Util>.
2663		2813
2664	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>,
2665	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>.
2666		2816
2667	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2817	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2668	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>,
2669	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2819	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2670	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.350 by root, Tue Aug 2 20:02:44 2011 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.350 by root, Tue Aug 2 20:02:44 2011 UTC vs.
Revision 1.364 by root, Mon Aug 15 12:56:53 2011 UTC