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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.330 by root, Tue Aug 31 00:59:55 2010 UTC vs.
Revision 1.360 by root, Sat Aug 13 22:44:05 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>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
126	L<POE>. The first one found is used. If none are found, the module tries	128	found is used. If none are detected, the module tries to load the first
127	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	129	four modules in the order given; but note that if L<EV> is not
128	adaptor should always succeed) in the order given. The first one that can	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
129	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
130	found, AnyEvent will fall back to a pure-perl event loop, which is not
131	very efficient, but should work everywhere.
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:
136		136
…		…
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 1.0	1201	# from common:.sense 3.4
1163	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\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.271';	1211	our $VERSION = '6.0';
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	# all autoloaded methods reserve the complete glob, not just the method slot.
		1298	# due to bugs in perls method cache implementation.
1231	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);
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		1300
1249	sub detect() {	1301	sub detect() {
		1302	local $!; # for good measure
		1303	local $SIG{__DIE__}; # we use eval
		1304
1250	# free some memory	1305	# free some memory
1251	*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;
1252		1314
1253	local $!; # for good measure
1254	local $SIG{__DIE__};
1255
1256	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1315	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1257	my $model = "AnyEvent::Impl::$1";	1316	my $model = $1;
		1317	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1258	if (eval "require $model") {	1318	if (eval "require $model") {
1259	$MODEL = $model;	1319	$MODEL = $model;
1260	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;
1261	} else {	1321	} else {
1262	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;
…		…
1291	last;	1351	last;
1292	}	1352	}
1293	}	1353	}
1294		1354
1295	$MODEL	1355	$MODEL
1296	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";
1297	}	1357	}
1298	}	1358	}
1299		1359
1300	@models = (); # free probe data	1360	# free memory only needed for probing
		1361	undef @models;
		1362	undef @REGISTRY;
1301		1363
1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1364	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1303	unshift @ISA, $MODEL;	1365	unshift @ISA, $MODEL;
1304		1366
1305	# now nuke some methods that are overriden by the backend.	1367	# now nuke some methods that are overridden by the backend.
1306	# SUPER is not allowed.	1368	# SUPER usage is not allowed in these.
1307	for (qw(time signal child idle)) {	1369	for (qw(time signal child idle)) {
1308	undef &{"AnyEvent::Base::$_"}	1370	undef &{"AnyEvent::Base::$_"}
1309	if defined &{"$MODEL\::$_"};	1371	if defined &{"$MODEL\::$_"};
1310	}	1372	}
1311		1373
1312	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	}
1313		1393
1314	(shift @post_detect)->() while @post_detect;	1394	(shift @post_detect)->() while @post_detect;
		1395	undef @post_detect;
1315		1396
1316	*post_detect = sub(&) {	1397	*post_detect = sub(&) {
1317	shift->();	1398	shift->();
1318		1399
1319	undef	1400	undef
1320	};	1401	};
1321		1402
1322	$MODEL	1403	$MODEL
1323	}	1404	}
1324		1405
1325	sub AUTOLOAD {	1406	for my $name (@methods) {
1326	(my $func = $AUTOLOAD) =~ s/.*://;	1407	*$name = sub {
1327
1328	$method{$func}
1329	or Carp::croak "$func: not a valid AnyEvent class method";
1330
1331	detect;	1408	detect;
1332		1409	# we use goto because
1333	my $class = shift;	1410	# a) it makes the thunk more transparent
1334	$class->$func (@_);	1411	# b) it allows us to delete the thunk later
		1412	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1413	};
1335	}	1414	}
1336		1415
1337	# 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
1338	# to support binding more than one watcher per filehandle (they usually	1417	# to support binding more than one watcher per filehandle (they usually
1339	# 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).
…		…
1363		1442
1364	package AE;	1443	package AE;
1365		1444
1366	our $VERSION = $AnyEvent::VERSION;	1445	our $VERSION = $AnyEvent::VERSION;
1367		1446
		1447	sub _reset() {
		1448	eval q{
1368	# 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
1369	# implementations can overwrite these.	1450	# implementations can overwrite these.
1370		1451
1371	sub io($$$) {	1452	sub io($$$) {
1372	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1453	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1373	}	1454	}
1374		1455
1375	sub timer($$$) {	1456	sub timer($$$) {
1376	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1457	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1377	}	1458	}
1378		1459
1379	sub signal($$) {	1460	sub signal($$) {
1380	AnyEvent->signal (signal => $_[0], cb => $_[1])	1461	AnyEvent->signal (signal => $_[0], cb => $_[1])
1381	}	1462	}
1382		1463
1383	sub child($$) {	1464	sub child($$) {
1384	AnyEvent->child (pid => $_[0], cb => $_[1])	1465	AnyEvent->child (pid => $_[0], cb => $_[1])
1385	}	1466	}
1386		1467
1387	sub idle($) {	1468	sub idle($) {
1388	AnyEvent->idle (cb => $_[0])	1469	AnyEvent->idle (cb => $_[0]);
1389	}	1470	}
1390		1471
1391	sub cv(;&) {	1472	sub cv(;&) {
1392	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1473	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1393	}	1474	}
1394		1475
1395	sub now() {	1476	sub now() {
1396	AnyEvent->now	1477	AnyEvent->now
1397	}	1478	}
1398		1479
1399	sub now_update() {	1480	sub now_update() {
1400	AnyEvent->now_update	1481	AnyEvent->now_update
1401	}	1482	}
1402		1483
1403	sub time() {	1484	sub time() {
1404	AnyEvent->time	1485	AnyEvent->time
		1486	}
		1487
		1488	*postpone = \&AnyEvent::postpone;
		1489	};
		1490	die if $@;
1405	}	1491	}
		1492
		1493	BEGIN { _reset }
1406		1494
1407	package AnyEvent::Base;	1495	package AnyEvent::Base;
1408		1496
1409	# default implementations for many methods	1497	# default implementations for many methods
1410		1498
…		…
1429		1517
1430	*now = \&time;	1518	*now = \&time;
1431		1519
1432	sub now_update { }	1520	sub now_update { }
1433		1521
		1522	sub _poll {
		1523	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1524	}
		1525
1434	# default implementation for ->condvar	1526	# default implementation for ->condvar
		1527	# in fact, the default should not be overwritten
1435		1528
1436	sub condvar {	1529	sub condvar {
1437	eval q{ # poor man's autoloading {}	1530	eval q{ # poor man's autoloading {}
1438	*condvar = sub {	1531	*condvar = sub {
1439	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1532	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1609	: sysread $SIGPIPE_R, (my $dummy), 9;	1702	: sysread $SIGPIPE_R, (my $dummy), 9;
1610		1703
1611	while (%SIG_EV) {	1704	while (%SIG_EV) {
1612	for (keys %SIG_EV) {	1705	for (keys %SIG_EV) {
1613	delete $SIG_EV{$_};	1706	delete $SIG_EV{$_};
1614	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1707	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1615	}	1708	}
1616	}	1709	}
1617	};	1710	};
1618	};	1711	};
1619	die if $@;	1712	die if $@;
…		…
1624	# default implementation for ->child	1717	# default implementation for ->child
1625		1718
1626	our %PID_CB;	1719	our %PID_CB;
1627	our $CHLD_W;	1720	our $CHLD_W;
1628	our $CHLD_DELAY_W;	1721	our $CHLD_DELAY_W;
1629	our $WNOHANG;
1630		1722
1631	# used by many Impl's	1723	# used by many Impl's
1632	sub _emit_childstatus($$) {	1724	sub _emit_childstatus($$) {
1633	my (undef, $rpid, $rstatus) = @_;	1725	my (undef, $rpid, $rstatus) = @_;
1634		1726
…		…
1641	eval q{ # poor man's autoloading {}	1733	eval q{ # poor man's autoloading {}
1642	*_sigchld = sub {	1734	*_sigchld = sub {
1643	my $pid;	1735	my $pid;
1644		1736
1645	AnyEvent->_emit_childstatus ($pid, $?)	1737	AnyEvent->_emit_childstatus ($pid, $?)
1646	while ($pid = waitpid -1, $WNOHANG) > 0;	1738	while ($pid = waitpid -1, WNOHANG) > 0;
1647	};	1739	};
1648		1740
1649	*child = sub {	1741	*child = sub {
1650	my (undef, %arg) = @_;	1742	my (undef, %arg) = @_;
1651		1743
1652	defined (my $pid = $arg{pid} + 0)	1744	my $pid = $arg{pid};
1653	or Carp::croak "required option 'pid' is missing";	1745	my $cb = $arg{cb};
1654		1746
1655	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1747	$PID_CB{$pid}{$cb+0} = $cb;
1656
1657	# WNOHANG is almost cetrainly 1 everywhere
1658	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1659	? 1
1660	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1661		1748
1662	unless ($CHLD_W) {	1749	unless ($CHLD_W) {
1663	$CHLD_W = AE::signal CHLD => \&_sigchld;	1750	$CHLD_W = AE::signal CHLD => \&_sigchld;
1664	# 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
1665	&_sigchld;	1752	&_sigchld;
1666	}	1753	}
1667		1754
1668	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1755	bless [$pid, $cb+0], "AnyEvent::Base::child"
1669	};	1756	};
1670		1757
1671	*AnyEvent::Base::child::DESTROY = sub {	1758	*AnyEvent::Base::child::DESTROY = sub {
1672	my ($pid, $cb) = @{$_[0]};	1759	my ($pid, $icb) = @{$_[0]};
1673		1760
1674	delete $PID_CB{$pid}{$cb};	1761	delete $PID_CB{$pid}{$icb};
1675	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1762	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1676		1763
1677	undef $CHLD_W unless keys %PID_CB;	1764	undef $CHLD_W unless keys %PID_CB;
1678	};	1765	};
1679	};	1766	};
…		…
1692		1779
1693	my ($cb, $w, $rcb) = $arg{cb};	1780	my ($cb, $w, $rcb) = $arg{cb};
1694		1781
1695	$rcb = sub {	1782	$rcb = sub {
1696	if ($cb) {	1783	if ($cb) {
1697	$w = _time;	1784	$w = AE::time;
1698	&$cb;	1785	&$cb;
1699	$w = _time - $w;	1786	$w = AE::time - $w;
1700		1787
1701	# 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,
1702	# within some limits	1789	# within some limits
1703	$w = 0.0001 if $w < 0.0001;	1790	$w = 0.0001 if $w < 0.0001;
1704	$w = 5 if $w > 5;	1791	$w = 5 if $w > 5;
…		…
1727		1814
1728	package AnyEvent::CondVar;	1815	package AnyEvent::CondVar;
1729		1816
1730	our @ISA = AnyEvent::CondVar::Base::;	1817	our @ISA = AnyEvent::CondVar::Base::;
1731		1818
		1819	# only to be used for subclassing
		1820	sub new {
		1821	my $class = shift;
		1822	bless AnyEvent->condvar (@_), $class
		1823	}
		1824
1732	package AnyEvent::CondVar::Base;	1825	package AnyEvent::CondVar::Base;
1733		1826
1734	#use overload	1827	#use overload
1735	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1828	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1736	# fallback => 1;	1829	# fallback => 1;
…		…
1745		1838
1746	sub _send {	1839	sub _send {
1747	# nop	1840	# nop
1748	}	1841	}
1749		1842
		1843	sub _wait {
		1844	AnyEvent->_poll until $_[0]{_ae_sent};
		1845	}
		1846
1750	sub send {	1847	sub send {
1751	my $cv = shift;	1848	my $cv = shift;
1752	$cv->{_ae_sent} = [@_];	1849	$cv->{_ae_sent} = [@_];
1753	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1850	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1754	$cv->_send;	1851	$cv->_send;
…		…
1761		1858
1762	sub ready {	1859	sub ready {
1763	$_[0]{_ae_sent}	1860	$_[0]{_ae_sent}
1764	}	1861	}
1765		1862
1766	sub _wait {
1767	$WAITING
1768	and !$_[0]{_ae_sent}
1769	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1770
1771	local $WAITING = 1;
1772	AnyEvent->one_event while !$_[0]{_ae_sent};
1773	}
1774
1775	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;
1776	$_[0]->_wait;	1869	$_[0]->_wait;
		1870	}
1777		1871
1778	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1872	$_[0]{_ae_croak}
1779	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]
1780	}	1878	}
1781		1879
1782	sub cb {	1880	sub cb {
1783	my $cv = shift;	1881	my $cv = shift;
1784		1882
…		…
1800	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1898	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1801	}	1899	}
1802		1900
1803	# undocumented/compatibility with pre-3.4	1901	# undocumented/compatibility with pre-3.4
1804	*broadcast = \&send;	1902	*broadcast = \&send;
1805	*wait = \&_wait;	1903	*wait = \&recv;
1806		1904
1807	=head1 ERROR AND EXCEPTION HANDLING	1905	=head1 ERROR AND EXCEPTION HANDLING
1808		1906
1809	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
1810	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
…		…
1862	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>
1863	>>, it is definitely recommended to keep it off in production. Keeping	1961	>>, it is definitely recommended to keep it off in production. Keeping
1864	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1962	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1865	can be very useful, however.	1963	can be very useful, however.
1866		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
1867	=item C<PERL_ANYEVENT_MODEL>	1987	=item C<PERL_ANYEVENT_MODEL>
1868		1988
1869	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
1870	auto detection and -probing kicks in. It must be a string consisting	1990	auto detection and -probing kicks in.
1871	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
1872	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
1873	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
1874	auto detection and -probing.	1996	auto detection and -probing.
1875		1997
1876	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).
1877		2001
1878	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
1879	could start your program like this:	2003	could start your program like this:
1880		2004
1881	PERL_ANYEVENT_MODEL=Perl perl ...	2005	PERL_ANYEVENT_MODEL=Perl perl ...
1882		2006
1883	=item C<PERL_ANYEVENT_PROTOCOLS>	2007	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2582		2706
2583	=item L<Time::HiRes>	2707	=item L<Time::HiRes>
2584		2708
2585	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
2586	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
2587	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
2588	try to use a monotonic clock for timing stability.	2712	try to use a monotonic clock for timing stability.
2589		2713
2590	=back	2714	=back
2591		2715
2592		2716
…		…
2654	pronounced).	2778	pronounced).
2655		2779
2656		2780
2657	=head1 SEE ALSO	2781	=head1 SEE ALSO
2658		2782
		2783	Tutorial/Introduction: L<AnyEvent::Intro>.
		2784
		2785	FAQ: L<AnyEvent::FAQ>.
		2786
2659	Utility functions: L<AnyEvent::Util>.	2787	Utility functions: L<AnyEvent::Util>.
2660		2788
2661	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>,
2662	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>.
2663		2791
2664	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2792	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2665	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>,
2666	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2794	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2667	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>.
…		…
2669	Non-blocking file handles, sockets, TCP clients and	2797	Non-blocking file handles, sockets, TCP clients and
2670	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2798	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2671		2799
2672	Asynchronous DNS: L<AnyEvent::DNS>.	2800	Asynchronous DNS: L<AnyEvent::DNS>.
2673		2801
2674	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2802	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2675	L<Coro::Event>,
2676		2803
2677	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2804	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2678	L<AnyEvent::HTTP>.	2805	L<AnyEvent::HTTP>.
2679		2806
2680		2807
2681	=head1 AUTHOR	2808	=head1 AUTHOR
2682		2809

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.330 by root, Tue Aug 31 00:59:55 2010 UTC vs. Revision 1.360 by root, Sat Aug 13 22:44:05 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.330 by root, Tue Aug 31 00:59:55 2010 UTC vs.
Revision 1.360 by root, Sat Aug 13 22:44:05 2011 UTC