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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC vs.
Revision 1.359 by root, Sat Aug 13 16:11:33 2011 UTC

…		…
46	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
47	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
48		48
49	=head1 SUPPORT	49	=head1 SUPPORT
50		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
51	There is a mailinglist for discussing all things AnyEvent, and an IRC	53	There also is a mailinglist for discussing all things AnyEvent, and an IRC
52	channel, too.	54	channel, too.
53		55
54	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	56	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
55	Repository>, at L<http://anyevent.schmorp.de>, for more info.	57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
56		58
…		…
83	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
84	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.
85		87
86	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
87	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
88	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
89	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
90	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
91	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
92	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,
93	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
94		96
95	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
96	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
97	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
98	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
…		…
119	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>
120	module.	122	module.
121		123
122	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
123	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
124	following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125	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
126	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
127	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
128	available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
129	the other two are not normally tried.	131	the other two are not normally tried.
130		132
131	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
132	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
133	that model the default. For example:	135	that model the default. For example:
…		…
140	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
141	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,
142	as very few modules hardcode event loops without announcing this very	144	as very few modules hardcode event loops without announcing this very
143	loudly.	145	loudly.
144		146
145	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
146	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
147	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
148		150
149	=head1 WATCHERS	151	=head1 WATCHERS
150		152
151	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
152	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
…		…
354	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
355	account.	357	account.
356		358
357	=item AnyEvent->now_update	359	=item AnyEvent->now_update
358		360
359	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
360	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 >>,
361	AnyEvent->now >>, above).	363	above).
362		364
363	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
364	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
365	might affect timers and time-outs.	367	might affect timers and time-outs.
366		368
…		…
480	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
481	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
482	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
483		485
484	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
485	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
486	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
487		489
488	Example: fork a process and wait for it	490	Example: fork a process and wait for it
489		491
490	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
491		493
…		…
858	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
859	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
860	AnyEvent itself.	862	AnyEvent itself.
861		863
862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
863	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
864		866
865	=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.
866		868
867	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
868	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
…		…
874	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
875	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
876	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
877	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
878	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).
879		884
880	=item Backends with special needs.	885	=item Backends with special needs.
881		886
882	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
883	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
884	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
885	everything should just work.	890	everything should just work.
886		891
887	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
888
889	Support for IO::Async can only be partial, as it is too broken and
890	architecturally limited to even support the AnyEvent API. It also
891	is the only event loop that needs the loop to be set explicitly, so
892	it can only be used by a main program knowing about AnyEvent. See
893	L<AnyEvent::Impl::IOAsync> for the gory details.
894
895	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
896		893
897	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
898		895
899	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
900		897
…		…
936		933
937	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
938	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
939	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
940	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).
941		942
942	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
943	created, use C<post_detect>.	944	created, use C<post_detect>.
944		945
945	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1008	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009	# as soon as it is	1010	# as soon as it is
1010	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011	}	1012	}
1012		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
1013	=back	1054	=back
1014		1055
1015	=head1 WHAT TO DO IN A MODULE	1056	=head1 WHAT TO DO IN A MODULE
1016		1057
1017	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
…		…
1050	modules might create watchers when they are loaded, and AnyEvent will	1091	modules might create watchers when they are loaded, and AnyEvent will
1051	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
1052	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.
1053		1094
1054	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
1055	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1096	C<AnyEvent::Loop> module, which gives you similar behaviour
1056	everywhere, but letting AnyEvent chose the model is generally better.	1097	everywhere, but letting AnyEvent chose the model is generally better.
1057		1098
1058	=head2 MAINLOOP EMULATION	1099	=head2 MAINLOOP EMULATION
1059		1100
1060	Sometimes (often for short test scripts, or even standalone programs who	1101	Sometimes (often for short test scripts, or even standalone programs who
…		…
1155		1196
1156	package AnyEvent;	1197	package AnyEvent;
1157		1198
1158	# basically a tuned-down version of common::sense	1199	# basically a tuned-down version of common::sense
1159	sub common_sense {	1200	sub common_sense {
1160	# from common:.sense 3.3	1201	# from common:.sense 3.4
1161	${^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";
1162	# 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)
1163	$^H \|= 0x00000600;	1204	$^H \|= 0x00000600;
1164	}	1205	}
1165		1206
1166	BEGIN { AnyEvent::common_sense }	1207	BEGIN { AnyEvent::common_sense }
1167		1208
1168	use Carp ();	1209	use Carp ();
1169		1210
1170	our $VERSION = '5.271';	1211	our $VERSION = '5.34';
1171	our $MODEL;	1212	our $MODEL;
1172		1213
1173	our $AUTOLOAD;
1174	our @ISA;	1214	our @ISA;
1175		1215
1176	our @REGISTRY;	1216	our @REGISTRY;
1177		1217
1178	our $VERBOSE;	1218	our $VERBOSE;
…		…
1198	$PROTOCOL{$_} = ++$idx	1238	$PROTOCOL{$_} = ++$idx
1199	for reverse split /\s,\s/,	1239	for reverse split /\s,\s/,
1200	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1240	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1201	}	1241	}
1202		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
1203	my @models = (	1277	our @models = (
1204	[EV:: => AnyEvent::Impl::EV:: , 1],	1278	[EV:: => AnyEvent::Impl::EV:: , 1],
1205	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1279	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1206	# everything below here will not (normally) be autoprobed	1280	# everything below here will not (normally) be autoprobed
1207	# as the pureperl backend should work everywhere	1281	# as the pure perl backend should work everywhere
1208	# and is usually faster	1282	# and is usually faster
1209	[Event:: => AnyEvent::Impl::Event::, 1],	1283	[Event:: => AnyEvent::Impl::Event::, 1],
1210	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1284	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1211	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1285	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1212	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1286	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1213	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1287	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1214	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1288	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1215	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1289	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1216	[Wx:: => AnyEvent::Impl::POE::],	1290	[Wx:: => AnyEvent::Impl::POE::],
1217	[Prima:: => AnyEvent::Impl::POE::],	1291	[Prima:: => AnyEvent::Impl::POE::],
1218	# IO::Async is just too broken - we would need workarounds for its	1292	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1219	# byzantine signal and broken child handling, among others.	1293	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1220	# IO::Async is rather hard to detect, as it doesn't have any	1294	[FLTK:: => AnyEvent::Impl::FLTK2::],
1221	# obvious default class.
1222	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1223	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1224	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1226	);	1295	);
1227		1296
1228	our %method = map +($_ => 1),	1297	# all autoloaded methods reserve the complete glob, not just the method slot.
		1298	# due to bugs in perls method cache implementation.
1229	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1299	our @methods = qw(io timer time now now_update signal child idle condvar);
1230
1231	our @post_detect;
1232
1233	sub post_detect(&) {
1234	my ($cb) = @_;
1235
1236	push @post_detect, $cb;
1237
1238	defined wantarray
1239	? bless \$cb, "AnyEvent::Util::postdetect"
1240	: ()
1241	}
1242
1243	sub AnyEvent::Util::postdetect::DESTROY {
1244	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1245	}
1246		1300
1247	sub detect() {	1301	sub detect() {
		1302	local $!; # for good measure
		1303	local $SIG{__DIE__}; # we use eval
		1304
1248	# free some memory	1305	# free some memory
1249	*detect = sub () { $MODEL };	1306	*detect = sub () { $MODEL };
		1307	# undef &func doesn't correctly update the method cache. grmbl.
		1308	# so we delete the whole glob. grmbl.
		1309	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1310	# a glob with an active sub. hrm. i hope it works, but perl is
		1311	# usually buggy in this department. sigh.
		1312	delete @{"AnyEvent::"}{@methods};
		1313	undef @methods;
1250		1314
1251	local $!; # for good measure
1252	local $SIG{__DIE__};
1253
1254	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1315	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1255	my $model = "AnyEvent::Impl::$1";	1316	my $model = $1;
		1317	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1256	if (eval "require $model") {	1318	if (eval "require $model") {
1257	$MODEL = $model;	1319	$MODEL = $model;
1258	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1320	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1259	} else {	1321	} else {
1260	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1322	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
…		…
1289	last;	1351	last;
1290	}	1352	}
1291	}	1353	}
1292		1354
1293	$MODEL	1355	$MODEL
1294	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1356	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1295	}	1357	}
1296	}	1358	}
1297		1359
1298	@models = (); # free probe data	1360	# free memory only needed for probing
		1361	undef @models;
		1362	undef @REGISTRY;
1299		1363
1300	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1364	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1301	unshift @ISA, $MODEL;	1365	unshift @ISA, $MODEL;
1302		1366
1303	# now nuke some methods that are overriden by the backend.	1367	# now nuke some methods that are overridden by the backend.
1304	# SUPER is not allowed.	1368	# SUPER usage is not allowed in these.
1305	for (qw(time signal child idle)) {	1369	for (qw(time signal child idle)) {
1306	undef &{"AnyEvent::Base::$_"}	1370	undef &{"AnyEvent::Base::$_"}
1307	if defined &{"$MODEL\::$_"};	1371	if defined &{"$MODEL\::$_"};
1308	}	1372	}
1309		1373
1310	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1374	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1375	require AnyEvent::Strict;
		1376	}
		1377
		1378	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1379	require AnyEvent::Debug;
		1380	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1381	}
		1382
		1383	if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1384	require AnyEvent::Socket;
		1385	require AnyEvent::Debug;
		1386
		1387	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1388	$shell =~ s/\$\$/$$/g;
		1389
		1390	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1391	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1392	}
1311		1393
1312	(shift @post_detect)->() while @post_detect;	1394	(shift @post_detect)->() while @post_detect;
		1395	undef @post_detect;
1313		1396
1314	*post_detect = sub(&) {	1397	*post_detect = sub(&) {
1315	shift->();	1398	shift->();
1316		1399
1317	undef	1400	undef
1318	};	1401	};
1319		1402
1320	$MODEL	1403	$MODEL
1321	}	1404	}
1322		1405
1323	sub AUTOLOAD {	1406	for my $name (@methods) {
1324	(my $func = $AUTOLOAD) =~ s/.*://;	1407	*$name = sub {
1325
1326	$method{$func}
1327	or Carp::croak "$func: not a valid AnyEvent class method";
1328
1329	detect;	1408	detect;
1330		1409	# we use goto because
1331	my $class = shift;	1410	# a) it makes the thunk more transparent
1332	$class->$func (@_);	1411	# b) it allows us to delete the thunk later
		1412	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1413	};
1333	}	1414	}
1334		1415
1335	# utility function to dup a filehandle. this is used by many backends	1416	# utility function to dup a filehandle. this is used by many backends
1336	# to support binding more than one watcher per filehandle (they usually	1417	# to support binding more than one watcher per filehandle (they usually
1337	# allow only one watcher per fd, so we dup it to get a different one).	1418	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1361		1442
1362	package AE;	1443	package AE;
1363		1444
1364	our $VERSION = $AnyEvent::VERSION;	1445	our $VERSION = $AnyEvent::VERSION;
1365		1446
		1447	sub _reset() {
		1448	eval q{
1366	# fall back to the main API by default - backends and AnyEvent::Base	1449	# fall back to the main API by default - backends and AnyEvent::Base
1367	# implementations can overwrite these.	1450	# implementations can overwrite these.
1368		1451
1369	sub io($$$) {	1452	sub io($$$) {
1370	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1453	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1371	}	1454	}
1372		1455
1373	sub timer($$$) {	1456	sub timer($$$) {
1374	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1457	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1375	}	1458	}
1376		1459
1377	sub signal($$) {	1460	sub signal($$) {
1378	AnyEvent->signal (signal => $_[0], cb => $_[1])	1461	AnyEvent->signal (signal => $_[0], cb => $_[1])
1379	}	1462	}
1380		1463
1381	sub child($$) {	1464	sub child($$) {
1382	AnyEvent->child (pid => $_[0], cb => $_[1])	1465	AnyEvent->child (pid => $_[0], cb => $_[1])
1383	}	1466	}
1384		1467
1385	sub idle($) {	1468	sub idle($) {
1386	AnyEvent->idle (cb => $_[0])	1469	AnyEvent->idle (cb => $_[0]);
1387	}	1470	}
1388		1471
1389	sub cv(;&) {	1472	sub cv(;&) {
1390	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1473	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1391	}	1474	}
1392		1475
1393	sub now() {	1476	sub now() {
1394	AnyEvent->now	1477	AnyEvent->now
1395	}	1478	}
1396		1479
1397	sub now_update() {	1480	sub now_update() {
1398	AnyEvent->now_update	1481	AnyEvent->now_update
1399	}	1482	}
1400		1483
1401	sub time() {	1484	sub time() {
1402	AnyEvent->time	1485	AnyEvent->time
		1486	}
		1487
		1488	*postpone = \&AnyEvent::postpone;
		1489	};
		1490	die if $@;
1403	}	1491	}
		1492
		1493	BEGIN { _reset }
1404		1494
1405	package AnyEvent::Base;	1495	package AnyEvent::Base;
1406		1496
1407	# default implementations for many methods	1497	# default implementations for many methods
1408		1498
…		…
1427		1517
1428	*now = \&time;	1518	*now = \&time;
1429		1519
1430	sub now_update { }	1520	sub now_update { }
1431		1521
		1522	sub _poll {
		1523	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1524	}
		1525
1432	# default implementation for ->condvar	1526	# default implementation for ->condvar
		1527	# in fact, the default should not be overwritten
1433		1528
1434	sub condvar {	1529	sub condvar {
1435	eval q{ # poor man's autoloading {}	1530	eval q{ # poor man's autoloading {}
1436	*condvar = sub {	1531	*condvar = sub {
1437	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1532	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1607	: sysread $SIGPIPE_R, (my $dummy), 9;	1702	: sysread $SIGPIPE_R, (my $dummy), 9;
1608		1703
1609	while (%SIG_EV) {	1704	while (%SIG_EV) {
1610	for (keys %SIG_EV) {	1705	for (keys %SIG_EV) {
1611	delete $SIG_EV{$_};	1706	delete $SIG_EV{$_};
1612	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1707	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1613	}	1708	}
1614	}	1709	}
1615	};	1710	};
1616	};	1711	};
1617	die if $@;	1712	die if $@;
…		…
1622	# default implementation for ->child	1717	# default implementation for ->child
1623		1718
1624	our %PID_CB;	1719	our %PID_CB;
1625	our $CHLD_W;	1720	our $CHLD_W;
1626	our $CHLD_DELAY_W;	1721	our $CHLD_DELAY_W;
1627	our $WNOHANG;
1628		1722
1629	# used by many Impl's	1723	# used by many Impl's
1630	sub _emit_childstatus($$) {	1724	sub _emit_childstatus($$) {
1631	my (undef, $rpid, $rstatus) = @_;	1725	my (undef, $rpid, $rstatus) = @_;
1632		1726
…		…
1639	eval q{ # poor man's autoloading {}	1733	eval q{ # poor man's autoloading {}
1640	*_sigchld = sub {	1734	*_sigchld = sub {
1641	my $pid;	1735	my $pid;
1642		1736
1643	AnyEvent->_emit_childstatus ($pid, $?)	1737	AnyEvent->_emit_childstatus ($pid, $?)
1644	while ($pid = waitpid -1, $WNOHANG) > 0;	1738	while ($pid = waitpid -1, WNOHANG) > 0;
1645	};	1739	};
1646		1740
1647	*child = sub {	1741	*child = sub {
1648	my (undef, %arg) = @_;	1742	my (undef, %arg) = @_;
1649		1743
1650	defined (my $pid = $arg{pid} + 0)	1744	my $pid = $arg{pid};
1651	or Carp::croak "required option 'pid' is missing";	1745	my $cb = $arg{cb};
1652		1746
1653	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1747	$PID_CB{$pid}{$cb+0} = $cb;
1654
1655	# WNOHANG is almost cetrainly 1 everywhere
1656	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1657	? 1
1658	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1659		1748
1660	unless ($CHLD_W) {	1749	unless ($CHLD_W) {
1661	$CHLD_W = AE::signal CHLD => \&_sigchld;	1750	$CHLD_W = AE::signal CHLD => \&_sigchld;
1662	# child could be a zombie already, so make at least one round	1751	# child could be a zombie already, so make at least one round
1663	&_sigchld;	1752	&_sigchld;
1664	}	1753	}
1665		1754
1666	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1755	bless [$pid, $cb+0], "AnyEvent::Base::child"
1667	};	1756	};
1668		1757
1669	*AnyEvent::Base::child::DESTROY = sub {	1758	*AnyEvent::Base::child::DESTROY = sub {
1670	my ($pid, $cb) = @{$_[0]};	1759	my ($pid, $icb) = @{$_[0]};
1671		1760
1672	delete $PID_CB{$pid}{$cb};	1761	delete $PID_CB{$pid}{$icb};
1673	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1762	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1674		1763
1675	undef $CHLD_W unless keys %PID_CB;	1764	undef $CHLD_W unless keys %PID_CB;
1676	};	1765	};
1677	};	1766	};
…		…
1690		1779
1691	my ($cb, $w, $rcb) = $arg{cb};	1780	my ($cb, $w, $rcb) = $arg{cb};
1692		1781
1693	$rcb = sub {	1782	$rcb = sub {
1694	if ($cb) {	1783	if ($cb) {
1695	$w = _time;	1784	$w = AE::time;
1696	&$cb;	1785	&$cb;
1697	$w = _time - $w;	1786	$w = AE::time - $w;
1698		1787
1699	# never use more then 50% of the time for the idle watcher,	1788	# never use more then 50% of the time for the idle watcher,
1700	# within some limits	1789	# within some limits
1701	$w = 0.0001 if $w < 0.0001;	1790	$w = 0.0001 if $w < 0.0001;
1702	$w = 5 if $w > 5;	1791	$w = 5 if $w > 5;
…		…
1725		1814
1726	package AnyEvent::CondVar;	1815	package AnyEvent::CondVar;
1727		1816
1728	our @ISA = AnyEvent::CondVar::Base::;	1817	our @ISA = AnyEvent::CondVar::Base::;
1729		1818
		1819	# only to be used for subclassing
		1820	sub new {
		1821	my $class = shift;
		1822	bless AnyEvent->condvar (@_), $class
		1823	}
		1824
1730	package AnyEvent::CondVar::Base;	1825	package AnyEvent::CondVar::Base;
1731		1826
1732	#use overload	1827	#use overload
1733	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1828	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1734	# fallback => 1;	1829	# fallback => 1;
…		…
1743		1838
1744	sub _send {	1839	sub _send {
1745	# nop	1840	# nop
1746	}	1841	}
1747		1842
		1843	sub _wait {
		1844	AnyEvent->_poll until $_[0]{_ae_sent};
		1845	}
		1846
1748	sub send {	1847	sub send {
1749	my $cv = shift;	1848	my $cv = shift;
1750	$cv->{_ae_sent} = [@_];	1849	$cv->{_ae_sent} = [@_];
1751	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1850	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1752	$cv->_send;	1851	$cv->_send;
…		…
1759		1858
1760	sub ready {	1859	sub ready {
1761	$_[0]{_ae_sent}	1860	$_[0]{_ae_sent}
1762	}	1861	}
1763		1862
1764	sub _wait {
1765	$WAITING
1766	and !$_[0]{_ae_sent}
1767	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1768
1769	local $WAITING = 1;
1770	AnyEvent->one_event while !$_[0]{_ae_sent};
1771	}
1772
1773	sub recv {	1863	sub recv {
		1864	unless ($_[0]{_ae_sent}) {
		1865	$WAITING
		1866	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1867
		1868	local $WAITING = 1;
1774	$_[0]->_wait;	1869	$_[0]->_wait;
		1870	}
1775		1871
1776	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1872	$_[0]{_ae_croak}
1777	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1873	and Carp::croak $_[0]{_ae_croak};
		1874
		1875	wantarray
		1876	? @{ $_[0]{_ae_sent} }
		1877	: $_[0]{_ae_sent}[0]
1778	}	1878	}
1779		1879
1780	sub cb {	1880	sub cb {
1781	my $cv = shift;	1881	my $cv = shift;
1782		1882
…		…
1798	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1898	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1799	}	1899	}
1800		1900
1801	# undocumented/compatibility with pre-3.4	1901	# undocumented/compatibility with pre-3.4
1802	*broadcast = \&send;	1902	*broadcast = \&send;
1803	*wait = \&_wait;	1903	*wait = \&recv;
1804		1904
1805	=head1 ERROR AND EXCEPTION HANDLING	1905	=head1 ERROR AND EXCEPTION HANDLING
1806		1906
1807	In general, AnyEvent does not do any error handling - it relies on the	1907	In general, AnyEvent does not do any error handling - it relies on the
1808	caller to do that if required. The L<AnyEvent::Strict> module (see also	1908	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1860	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	1960	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1861	>>, it is definitely recommended to keep it off in production. Keeping	1961	>>, it is definitely recommended to keep it off in production. Keeping
1862	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1962	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1863	can be very useful, however.	1963	can be very useful, however.
1864		1964
		1965	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		1966
		1967	If this env variable is set, then its contents will be interpreted by
		1968	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		1969	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		1970	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		1971
		1972	This takes place when the first watcher is created.
		1973
		1974	For example, to bind a debug shell on a unix domain socket in
		1975	F<< /tmp/debug<pid>.sock >>, you could use this:
		1976
		1977	PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug\$\$.sock perlprog
		1978
		1979	Note that creating sockets in F</tmp> is very unsafe on multiuser
		1980	systems.
		1981
		1982	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		1983
		1984	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		1985	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		1986
1865	=item C<PERL_ANYEVENT_MODEL>	1987	=item C<PERL_ANYEVENT_MODEL>
1866		1988
1867	This can be used to specify the event model to be used by AnyEvent, before	1989	This can be used to specify the event model to be used by AnyEvent, before
1868	auto detection and -probing kicks in. It must be a string consisting	1990	auto detection and -probing kicks in.
1869	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1991
		1992	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		1993	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1870	and the resulting module name is loaded and if the load was successful,	1994	resulting module name is loaded and - if the load was successful - used as
1871	used as event model. If it fails to load AnyEvent will proceed with	1995	event model backend. If it fails to load then AnyEvent will proceed with
1872	auto detection and -probing.	1996	auto detection and -probing.
1873		1997
1874	This functionality might change in future versions.	1998	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		1999	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2000	the end of a string designates a module name and quotes it appropriately).
1875		2001
1876	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2002	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1877	could start your program like this:	2003	could start your program like this:
1878		2004
1879	PERL_ANYEVENT_MODEL=Perl perl ...	2005	PERL_ANYEVENT_MODEL=Perl perl ...
1880		2006
1881	=item C<PERL_ANYEVENT_PROTOCOLS>	2007	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2580		2706
2581	=item L<Time::HiRes>	2707	=item L<Time::HiRes>
2582		2708
2583	This module is part of perl since release 5.008. It will be used when the	2709	This module is part of perl since release 5.008. It will be used when the
2584	chosen event library does not come with a timing source of its own. The	2710	chosen event library does not come with a timing source of its own. The
2585	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2711	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2586	try to use a monotonic clock for timing stability.	2712	try to use a monotonic clock for timing stability.
2587		2713
2588	=back	2714	=back
2589		2715
2590		2716
…		…
2652	pronounced).	2778	pronounced).
2653		2779
2654		2780
2655	=head1 SEE ALSO	2781	=head1 SEE ALSO
2656		2782
		2783	Tutorial/Introduction: L<AnyEvent::Intro>.
		2784
		2785	FAQ: L<AnyEvent::FAQ>.
		2786
2657	Utility functions: L<AnyEvent::Util>.	2787	Utility functions: L<AnyEvent::Util>.
2658		2788
2659	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2789	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2660	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2790	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2661		2791
2662	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2792	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2793	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2794	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2795	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
…		…
2667	Non-blocking file handles, sockets, TCP clients and	2797	Non-blocking file handles, sockets, TCP clients and
2668	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2798	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669		2799
2670	Asynchronous DNS: L<AnyEvent::DNS>.	2800	Asynchronous DNS: L<AnyEvent::DNS>.
2671		2801
2672	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2802	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2673	L<Coro::Event>,
2674		2803
2675	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2804	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2676	L<AnyEvent::HTTP>.	2805	L<AnyEvent::HTTP>.
2677		2806
2678		2807
2679	=head1 AUTHOR	2808	=head1 AUTHOR
2680		2809

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC vs. Revision 1.359 by root, Sat Aug 13 16:11:33 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC vs.
Revision 1.359 by root, Sat Aug 13 16:11:33 2011 UTC