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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.341 by root, Sun Dec 5 11:41:45 2010 UTC vs.
Revision 1.362 by root, Sun Aug 14 01:57:18 2011 UTC

…		…
85	that isn't them. What's worse, all the potential users of your	85	that isn't them. What's worse, all the potential users of your
86	module are I<also> forced to use the same event loop you use.	86	module are I<also> forced to use the same event loop you use.
87		87
88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
90	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
91	your module uses one of those, every user of your module has to use it,	91	uses one of those, every user of your module has to use it, too. But if
92	too. But if your module uses AnyEvent, it works transparently with all	92	your module uses AnyEvent, it works transparently with all event models it
93	event models it supports (including stuff like IO::Async, as long as those	93	supports (including stuff like IO::Async, as long as those use one of the
94	use one of the supported event loops. It is easy to add new event loops	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
95	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
96		96
97	In addition to being free of having to use I<the one and only true event	97	In addition to being free of having to use I<the one and only true event
98	model>, AnyEvent also is free of bloat and policy: with POE or similar	98	model>, AnyEvent also is free of bloat and policy: with POE or similar
99	modules, you get an enormous amount of code and strict rules you have to	99	modules, you get an enormous amount of code and strict rules you have to
100	follow. AnyEvent, on the other hand, is lean and to the point, by only	100	follow. AnyEvent, on the other hand, is lean and to the point, by only
…		…
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
…		…
876	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
877	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
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.
		882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
881		884
882	=item Backends with special needs.	885	=item Backends with special needs.
883		886
884	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
885	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
886	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
887	everything should just work.	890	everything should just work.
888		891
889	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
890
891	Support for IO::Async can only be partial, as it is too broken and
892	architecturally limited to even support the AnyEvent API. It also
893	is the only event loop that needs the loop to be set explicitly, so
894	it can only be used by a main program knowing about AnyEvent. See
895	L<AnyEvent::Impl::IOAsync> for the gory details.
896
897	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
898		893
899	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
900		895
901	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
902		897
…		…
938		933
939	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
940	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
941	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
942	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).
943		942
944	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
945	created, use C<post_detect>.	944	created, use C<post_detect>.
946		945
947	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1010	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1011	# as soon as it is	1010	# as soon as it is
1012	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1013	}	1012	}
1014		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
1015	=back	1054	=back
1016		1055
1017	=head1 WHAT TO DO IN A MODULE	1056	=head1 WHAT TO DO IN A MODULE
1018		1057
1019	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
…		…
1052	modules might create watchers when they are loaded, and AnyEvent will	1091	modules might create watchers when they are loaded, and AnyEvent will
1053	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
1054	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.
1055		1094
1056	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
1057	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1096	C<AnyEvent::Loop> module, which gives you similar behaviour
1058	everywhere, but letting AnyEvent chose the model is generally better.	1097	everywhere, but letting AnyEvent chose the model is generally better.
1059		1098
1060	=head2 MAINLOOP EMULATION	1099	=head2 MAINLOOP EMULATION
1061		1100
1062	Sometimes (often for short test scripts, or even standalone programs who	1101	Sometimes (often for short test scripts, or even standalone programs who
…		…
1157		1196
1158	package AnyEvent;	1197	package AnyEvent;
1159		1198
1160	# basically a tuned-down version of common::sense	1199	# basically a tuned-down version of common::sense
1161	sub common_sense {	1200	sub common_sense {
1162	# from common:.sense 3.3	1201	# from common:.sense 3.4
1163	${^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";
1164	# 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)
1165	$^H \|= 0x00000600;	1204	$^H \|= 0x00000600;
1166	}	1205	}
1167		1206
1168	BEGIN { AnyEvent::common_sense }	1207	BEGIN { AnyEvent::common_sense }
1169		1208
1170	use Carp ();	1209	use Carp ();
1171		1210
1172	our $VERSION = '5.29';	1211	our $VERSION = '6.01';
1173	our $MODEL;	1212	our $MODEL;
1174		1213
1175	our $AUTOLOAD;
1176	our @ISA;	1214	our @ISA;
1177		1215
1178	our @REGISTRY;	1216	our @REGISTRY;
1179		1217
1180	our $VERBOSE;	1218	our $VERBOSE;
…		…
1200	$PROTOCOL{$_} = ++$idx	1238	$PROTOCOL{$_} = ++$idx
1201	for reverse split /\s,\s/,	1239	for reverse split /\s,\s/,
1202	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1240	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1203	}	1241	}
1204		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
1205	my @models = (	1277	our @models = (
1206	[EV:: => AnyEvent::Impl::EV:: , 1],	1278	[EV:: => AnyEvent::Impl::EV:: , 1],
1207	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1279	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1208	# everything below here will not (normally) be autoprobed	1280	# everything below here will not (normally) be autoprobed
1209	# as the pureperl backend should work everywhere	1281	# as the pure perl backend should work everywhere
1210	# and is usually faster	1282	# and is usually faster
1211	[Event:: => AnyEvent::Impl::Event::, 1],	1283	[Event:: => AnyEvent::Impl::Event::, 1],
1212	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1284	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1213	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1285	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1214	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1286	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1215	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1287	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1216	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1288	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1217	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1289	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1218	[Wx:: => AnyEvent::Impl::POE::],	1290	[Wx:: => AnyEvent::Impl::POE::],
1219	[Prima:: => AnyEvent::Impl::POE::],	1291	[Prima:: => AnyEvent::Impl::POE::],
1220	# IO::Async is just too broken - we would need workarounds for its	1292	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1221	# byzantine signal and broken child handling, among others.	1293	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1222	# IO::Async is rather hard to detect, as it doesn't have any	1294	[FLTK:: => AnyEvent::Impl::FLTK2::],
1223	# obvious default class.
1224	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1226	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1227	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1228	);	1295	);
1229		1296
1230	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.
1231	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);
1232
1233	our @post_detect;
1234
1235	sub post_detect(&) {
1236	my ($cb) = @_;
1237
1238	push @post_detect, $cb;
1239
1240	defined wantarray
1241	? bless \$cb, "AnyEvent::Util::postdetect"
1242	: ()
1243	}
1244
1245	sub AnyEvent::Util::postdetect::DESTROY {
1246	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1247	}
1248		1321
1249	sub detect() {	1322	sub detect() {
		1323	local $!; # for good measure
		1324	local $SIG{__DIE__}; # we use eval
		1325
1250	# free some memory	1326	# free some memory
1251	*detect = sub () { $MODEL };	1327	*detect = sub () { $MODEL };
		1328	# undef &func doesn't correctly update the method cache. grmbl.
		1329	# so we delete the whole glob. grmbl.
		1330	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1331	# a glob with an active sub. hrm. i hope it works, but perl is
		1332	# usually buggy in this department. sigh.
		1333	delete @{"AnyEvent::"}{@methods};
		1334	undef @methods;
1252		1335
1253	local $!; # for good measure
1254	local $SIG{__DIE__};
1255
1256	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1336	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1257	my $model = "AnyEvent::Impl::$1";	1337	my $model = $1;
		1338	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1258	if (eval "require $model") {	1339	if (eval "require $model") {
1259	$MODEL = $model;	1340	$MODEL = $model;
1260	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1341	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1261	} else {	1342	} else {
1262	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1343	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
…		…
1295	$MODEL	1376	$MODEL
1296	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1377	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1297	}	1378	}
1298	}	1379	}
1299		1380
1300	@models = (); # free probe data	1381	# free memory only needed for probing
		1382	undef @models;
		1383	undef @REGISTRY;
1301		1384
1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1385	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1303	unshift @ISA, $MODEL;
1304		1386
1305	# now nuke some methods that are overridden by the backend.	1387	# now nuke some methods that are overridden by the backend.
1306	# SUPER is not allowed.	1388	# SUPER usage is not allowed in these.
1307	for (qw(time signal child idle)) {	1389	for (qw(time signal child idle)) {
1308	undef &{"AnyEvent::Base::$_"}	1390	undef &{"AnyEvent::Base::$_"}
1309	if defined &{"$MODEL\::$_"};	1391	if defined &{"$MODEL\::$_"};
1310	}	1392	}
1311		1393
		1394	_isa_set;
		1395
1312	if ($ENV{PERL_ANYEVENT_STRICT}) {	1396	if ($ENV{PERL_ANYEVENT_STRICT}) {
1313	eval { require AnyEvent::Strict };	1397	require AnyEvent::Strict;
1314	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1315	if $@ && $VERBOSE;
1316	}	1398	}
1317		1399
		1400	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1401	require AnyEvent::Debug;
		1402	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1403	}
		1404
		1405	if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1406	require AnyEvent::Socket;
		1407	require AnyEvent::Debug;
		1408
		1409	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1410	$shell =~ s/\$\$/$$/g;
		1411
		1412	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1413	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1414	}
		1415
1318	(shift @post_detect)->() while @post_detect;	1416	(shift @post_detect)->() while @post_detect;
		1417	undef @post_detect;
1319		1418
1320	*post_detect = sub(&) {	1419	*post_detect = sub(&) {
1321	shift->();	1420	shift->();
1322		1421
1323	undef	1422	undef
1324	};	1423	};
1325		1424
1326	$MODEL	1425	$MODEL
1327	}	1426	}
1328		1427
1329	sub AUTOLOAD {	1428	for my $name (@methods) {
1330	(my $func = $AUTOLOAD) =~ s/.*://;	1429	*$name = sub {
1331
1332	$method{$func}
1333	or Carp::croak "$func: not a valid AnyEvent class method";
1334
1335	detect;	1430	detect;
1336		1431	# we use goto because
1337	my $class = shift;	1432	# a) it makes the thunk more transparent
1338	$class->$func (@_);	1433	# b) it allows us to delete the thunk later
		1434	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1435	};
1339	}	1436	}
1340		1437
1341	# utility function to dup a filehandle. this is used by many backends	1438	# utility function to dup a filehandle. this is used by many backends
1342	# to support binding more than one watcher per filehandle (they usually	1439	# to support binding more than one watcher per filehandle (they usually
1343	# allow only one watcher per fd, so we dup it to get a different one).	1440	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1367		1464
1368	package AE;	1465	package AE;
1369		1466
1370	our $VERSION = $AnyEvent::VERSION;	1467	our $VERSION = $AnyEvent::VERSION;
1371		1468
		1469	sub _reset() {
		1470	eval q{
1372	# fall back to the main API by default - backends and AnyEvent::Base	1471	# fall back to the main API by default - backends and AnyEvent::Base
1373	# implementations can overwrite these.	1472	# implementations can overwrite these.
1374		1473
1375	sub io($$$) {	1474	sub io($$$) {
1376	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1475	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1377	}	1476	}
1378		1477
1379	sub timer($$$) {	1478	sub timer($$$) {
1380	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1479	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1381	}	1480	}
1382		1481
1383	sub signal($$) {	1482	sub signal($$) {
1384	AnyEvent->signal (signal => $_[0], cb => $_[1])	1483	AnyEvent->signal (signal => $_[0], cb => $_[1])
1385	}	1484	}
1386		1485
1387	sub child($$) {	1486	sub child($$) {
1388	AnyEvent->child (pid => $_[0], cb => $_[1])	1487	AnyEvent->child (pid => $_[0], cb => $_[1])
1389	}	1488	}
1390		1489
1391	sub idle($) {	1490	sub idle($) {
1392	AnyEvent->idle (cb => $_[0])	1491	AnyEvent->idle (cb => $_[0]);
1393	}	1492	}
1394		1493
1395	sub cv(;&) {	1494	sub cv(;&) {
1396	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1495	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1397	}	1496	}
1398		1497
1399	sub now() {	1498	sub now() {
1400	AnyEvent->now	1499	AnyEvent->now
1401	}	1500	}
1402		1501
1403	sub now_update() {	1502	sub now_update() {
1404	AnyEvent->now_update	1503	AnyEvent->now_update
1405	}	1504	}
1406		1505
1407	sub time() {	1506	sub time() {
1408	AnyEvent->time	1507	AnyEvent->time
		1508	}
		1509
		1510	*postpone = \&AnyEvent::postpone;
		1511	};
		1512	die if $@;
1409	}	1513	}
		1514
		1515	BEGIN { _reset }
1410		1516
1411	package AnyEvent::Base;	1517	package AnyEvent::Base;
1412		1518
1413	# default implementations for many methods	1519	# default implementations for many methods
1414		1520
1415	sub time {	1521	sub time {
1416	eval q{ # poor man's autoloading {}	1522	eval q{ # poor man's autoloading {}
1417	# probe for availability of Time::HiRes	1523	# probe for availability of Time::HiRes
1418	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1524	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1419	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1525	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
		1526	*time = sub { Time::HiRes::time () };
1420	*AE::time = \&Time::HiRes::time;	1527	*AE::time = \& Time::HiRes::time ;
1421	# if (eval "use POSIX (); (POSIX::times())...	1528	# if (eval "use POSIX (); (POSIX::times())...
1422	} else {	1529	} else {
1423	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1530	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
		1531	*time = sub { CORE::time };
1424	*AE::time = sub (){ time }; # epic fail	1532	*AE::time = sub (){ CORE::time };
1425	}	1533	}
1426		1534
1427	*time = sub { AE::time }; # different prototypes	1535	*now = \&time;
1428	};	1536	};
1429	die if $@;	1537	die if $@;
1430		1538
1431	&time	1539	&time
1432	}	1540	}
1433		1541
1434	*now = \&time;	1542	*now = \&time;
1435
1436	sub now_update { }	1543	sub now_update { }
1437		1544
		1545	sub _poll {
		1546	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1547	}
		1548
1438	# default implementation for ->condvar	1549	# default implementation for ->condvar
		1550	# in fact, the default should not be overwritten
1439		1551
1440	sub condvar {	1552	sub condvar {
1441	eval q{ # poor man's autoloading {}	1553	eval q{ # poor man's autoloading {}
1442	*condvar = sub {	1554	*condvar = sub {
1443	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1555	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1613	: sysread $SIGPIPE_R, (my $dummy), 9;	1725	: sysread $SIGPIPE_R, (my $dummy), 9;
1614		1726
1615	while (%SIG_EV) {	1727	while (%SIG_EV) {
1616	for (keys %SIG_EV) {	1728	for (keys %SIG_EV) {
1617	delete $SIG_EV{$_};	1729	delete $SIG_EV{$_};
1618	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1730	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1619	}	1731	}
1620	}	1732	}
1621	};	1733	};
1622	};	1734	};
1623	die if $@;	1735	die if $@;
…		…
1650	};	1762	};
1651		1763
1652	*child = sub {	1764	*child = sub {
1653	my (undef, %arg) = @_;	1765	my (undef, %arg) = @_;
1654		1766
1655	defined (my $pid = $arg{pid} + 0)	1767	my $pid = $arg{pid};
1656	or Carp::croak "required option 'pid' is missing";	1768	my $cb = $arg{cb};
1657		1769
1658	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1770	$PID_CB{$pid}{$cb+0} = $cb;
1659		1771
1660	unless ($CHLD_W) {	1772	unless ($CHLD_W) {
1661	$CHLD_W = AE::signal CHLD => \&_sigchld;	1773	$CHLD_W = AE::signal CHLD => \&_sigchld;
1662	# child could be a zombie already, so make at least one round	1774	# child could be a zombie already, so make at least one round
1663	&_sigchld;	1775	&_sigchld;
1664	}	1776	}
1665		1777
1666	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1778	bless [$pid, $cb+0], "AnyEvent::Base::child"
1667	};	1779	};
1668		1780
1669	*AnyEvent::Base::child::DESTROY = sub {	1781	*AnyEvent::Base::child::DESTROY = sub {
1670	my ($pid, $cb) = @{$_[0]};	1782	my ($pid, $icb) = @{$_[0]};
1671		1783
1672	delete $PID_CB{$pid}{$cb};	1784	delete $PID_CB{$pid}{$icb};
1673	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1785	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1674		1786
1675	undef $CHLD_W unless keys %PID_CB;	1787	undef $CHLD_W unless keys %PID_CB;
1676	};	1788	};
1677	};	1789	};
…		…
1690		1802
1691	my ($cb, $w, $rcb) = $arg{cb};	1803	my ($cb, $w, $rcb) = $arg{cb};
1692		1804
1693	$rcb = sub {	1805	$rcb = sub {
1694	if ($cb) {	1806	if ($cb) {
1695	$w = _time;	1807	$w = AE::time;
1696	&$cb;	1808	&$cb;
1697	$w = _time - $w;	1809	$w = AE::time - $w;
1698		1810
1699	# never use more then 50% of the time for the idle watcher,	1811	# never use more then 50% of the time for the idle watcher,
1700	# within some limits	1812	# within some limits
1701	$w = 0.0001 if $w < 0.0001;	1813	$w = 0.0001 if $w < 0.0001;
1702	$w = 5 if $w > 5;	1814	$w = 5 if $w > 5;
…		…
1749		1861
1750	sub _send {	1862	sub _send {
1751	# nop	1863	# nop
1752	}	1864	}
1753		1865
		1866	sub _wait {
		1867	AnyEvent->_poll until $_[0]{_ae_sent};
		1868	}
		1869
1754	sub send {	1870	sub send {
1755	my $cv = shift;	1871	my $cv = shift;
1756	$cv->{_ae_sent} = [@_];	1872	$cv->{_ae_sent} = [@_];
1757	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1873	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1758	$cv->_send;	1874	$cv->_send;
…		…
1765		1881
1766	sub ready {	1882	sub ready {
1767	$_[0]{_ae_sent}	1883	$_[0]{_ae_sent}
1768	}	1884	}
1769		1885
1770	sub _wait {
1771	$WAITING
1772	and !$_[0]{_ae_sent}
1773	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1774
1775	local $WAITING = 1;
1776	AnyEvent->one_event while !$_[0]{_ae_sent};
1777	}
1778
1779	sub recv {	1886	sub recv {
		1887	unless ($_[0]{_ae_sent}) {
		1888	$WAITING
		1889	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1890
		1891	local $WAITING = 1;
1780	$_[0]->_wait;	1892	$_[0]->_wait;
		1893	}
1781		1894
1782	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1895	$_[0]{_ae_croak}
1783	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1896	and Carp::croak $_[0]{_ae_croak};
		1897
		1898	wantarray
		1899	? @{ $_[0]{_ae_sent} }
		1900	: $_[0]{_ae_sent}[0]
1784	}	1901	}
1785		1902
1786	sub cb {	1903	sub cb {
1787	my $cv = shift;	1904	my $cv = shift;
1788		1905
…		…
1804	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1921	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1805	}	1922	}
1806		1923
1807	# undocumented/compatibility with pre-3.4	1924	# undocumented/compatibility with pre-3.4
1808	*broadcast = \&send;	1925	*broadcast = \&send;
1809	*wait = \&_wait;	1926	*wait = \&recv;
1810		1927
1811	=head1 ERROR AND EXCEPTION HANDLING	1928	=head1 ERROR AND EXCEPTION HANDLING
1812		1929
1813	In general, AnyEvent does not do any error handling - it relies on the	1930	In general, AnyEvent does not do any error handling - it relies on the
1814	caller to do that if required. The L<AnyEvent::Strict> module (see also	1931	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1866	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	1983	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	1984	>>, it is definitely recommended to keep it off in production. Keeping
1868	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1985	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1869	can be very useful, however.	1986	can be very useful, however.
1870		1987
		1988	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		1989
		1990	If this env variable is set, then its contents will be interpreted by
		1991	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		1992	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		1993	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		1994
		1995	This takes place when the first watcher is created.
		1996
		1997	For example, to bind a debug shell on a unix domain socket in
		1998	F<< /tmp/debug<pid>.sock >>, you could use this:
		1999
		2000	PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug\$\$.sock perlprog
		2001
		2002	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2003	systems.
		2004
		2005	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2006
		2007	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2008	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2009
1871	=item C<PERL_ANYEVENT_MODEL>	2010	=item C<PERL_ANYEVENT_MODEL>
1872		2011
1873	This can be used to specify the event model to be used by AnyEvent, before	2012	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	2013	auto detection and -probing kicks in.
1875	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2014
		2015	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2016	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,	2017	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	2018	event model backend. If it fails to load then AnyEvent will proceed with
1878	auto detection and -probing.	2019	auto detection and -probing.
1879		2020
1880	This functionality might change in future versions.	2021	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2022	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2023	the end of a string designates a module name and quotes it appropriately).
1881		2024
1882	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2025	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1883	could start your program like this:	2026	could start your program like this:
1884		2027
1885	PERL_ANYEVENT_MODEL=Perl perl ...	2028	PERL_ANYEVENT_MODEL=Perl perl ...
1886		2029
1887	=item C<PERL_ANYEVENT_PROTOCOLS>	2030	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2277	(even when used without AnyEvent), but most event loops have acceptable	2420	(even when used without AnyEvent), but most event loops have acceptable
2278	performance with or without AnyEvent.	2421	performance with or without AnyEvent.
2279		2422
2280	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2423	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2281	the actual event loop, only with extremely fast event loops such as EV	2424	the actual event loop, only with extremely fast event loops such as EV
2282	adds AnyEvent significant overhead.	2425	does AnyEvent add significant overhead.
2283		2426
2284	=item * You should avoid POE like the plague if you want performance or	2427	=item * You should avoid POE like the plague if you want performance or
2285	reasonable memory usage.	2428	reasonable memory usage.
2286		2429
2287	=back	2430	=back
…		…
2586		2729
2587	=item L<Time::HiRes>	2730	=item L<Time::HiRes>
2588		2731
2589	This module is part of perl since release 5.008. It will be used when the	2732	This module is part of perl since release 5.008. It will be used when the
2590	chosen event library does not come with a timing source of its own. The	2733	chosen event library does not come with a timing source of its own. The
2591	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2734	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2592	try to use a monotonic clock for timing stability.	2735	try to use a monotonic clock for timing stability.
2593		2736
2594	=back	2737	=back
2595		2738
2596		2739
…		…
2664		2807
2665	FAQ: L<AnyEvent::FAQ>.	2808	FAQ: L<AnyEvent::FAQ>.
2666		2809
2667	Utility functions: L<AnyEvent::Util>.	2810	Utility functions: L<AnyEvent::Util>.
2668		2811
2669	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2812	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2670	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2813	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2671		2814
2672	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2815	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2673	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2816	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2674	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2817	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2675	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2818	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.341 by root, Sun Dec 5 11:41:45 2010 UTC vs. Revision 1.362 by root, Sun Aug 14 01:57:18 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.341 by root, Sun Dec 5 11:41:45 2010 UTC vs.
Revision 1.362 by root, Sun Aug 14 01:57:18 2011 UTC