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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.338 by root, Tue Nov 23 04:45:59 2010 UTC vs.
Revision 1.358 by root, Sat Aug 13 02:35:32 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
…		…
1010	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1011	# as soon as it is	1006	# as soon as it is
1012	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1013	}	1008	}
1014		1009
		1010	=item AnyEvent::postpone { BLOCK }
		1011
		1012	Arranges for the block to be executed as soon as possible, but not before
		1013	the call itself returns. In practise, the block will be executed just
		1014	before the event loop polls for new events, or shortly afterwards.
		1015
		1016	This function never returns anything (to make the C<return postpone { ...
		1017	}> idiom more useful.
		1018
		1019	To understand the usefulness of this function, consider a function that
		1020	asynchronously does something for you and returns some transaction
		1021	object or guard to let you cancel the operation. For example,
		1022	C<AnyEvent::Socket::tcp_connect>:
		1023
		1024	# start a conenction attempt unless one is active
		1025	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1026	delete $self->{connect_guard};
		1027	...
		1028	};
		1029
		1030	Imagine that this function could instantly call the callback, for
		1031	example, because it detects an obvious error such as a negative port
		1032	number. Invoking the callback before the function returns causes problems
		1033	however: the callback will be called and will try to delete the guard
		1034	object. But since the function hasn't returned yet, there is nothing to
		1035	delete. When the function eventually returns it will assign the guard
		1036	object to C<< $self->{connect_guard} >>, where it will likely never be
		1037	deleted, so the program thinks it is still trying to connect.
		1038
		1039	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1040	callback directly on error:
		1041
		1042	$cb->(undef), return # signal error to callback, BAD!
		1043	if $some_error_condition;
		1044
		1045	It should use C<postpone>:
		1046
		1047	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1048	if $some_error_condition;
		1049
1015	=back	1050	=back
1016		1051
1017	=head1 WHAT TO DO IN A MODULE	1052	=head1 WHAT TO DO IN A MODULE
1018		1053
1019	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1054	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	1087	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	1088	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.	1089	might choose the wrong one unless you load the correct one yourself.
1055		1090
1056	You can chose to use a pure-perl implementation by loading the	1091	You can chose to use a pure-perl implementation by loading the
1057	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1092	C<AnyEvent::Loop> module, which gives you similar behaviour
1058	everywhere, but letting AnyEvent chose the model is generally better.	1093	everywhere, but letting AnyEvent chose the model is generally better.
1059		1094
1060	=head2 MAINLOOP EMULATION	1095	=head2 MAINLOOP EMULATION
1061		1096
1062	Sometimes (often for short test scripts, or even standalone programs who	1097	Sometimes (often for short test scripts, or even standalone programs who
…		…
1157		1192
1158	package AnyEvent;	1193	package AnyEvent;
1159		1194
1160	# basically a tuned-down version of common::sense	1195	# basically a tuned-down version of common::sense
1161	sub common_sense {	1196	sub common_sense {
1162	# from common:.sense 3.3	1197	# from common:.sense 3.4
1163	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";	1198	${^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)	1199	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1165	$^H \|= 0x00000600;	1200	$^H \|= 0x00000600;
1166	}	1201	}
1167		1202
1168	BEGIN { AnyEvent::common_sense }	1203	BEGIN { AnyEvent::common_sense }
1169		1204
1170	use Carp ();	1205	use Carp ();
1171		1206
1172	our $VERSION = '5.29';	1207	our $VERSION = '5.34';
1173	our $MODEL;	1208	our $MODEL;
1174		1209
1175	our $AUTOLOAD;
1176	our @ISA;	1210	our @ISA;
1177		1211
1178	our @REGISTRY;	1212	our @REGISTRY;
1179		1213
1180	our $VERBOSE;	1214	our $VERBOSE;
…		…
1200	$PROTOCOL{$_} = ++$idx	1234	$PROTOCOL{$_} = ++$idx
1201	for reverse split /\s,\s/,	1235	for reverse split /\s,\s/,
1202	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1236	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1203	}	1237	}
1204		1238
		1239	our @post_detect;
		1240
		1241	sub post_detect(&) {
		1242	my ($cb) = @_;
		1243
		1244	push @post_detect, $cb;
		1245
		1246	defined wantarray
		1247	? bless \$cb, "AnyEvent::Util::postdetect"
		1248	: ()
		1249	}
		1250
		1251	sub AnyEvent::Util::postdetect::DESTROY {
		1252	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1253	}
		1254
		1255	our $POSTPONE_W;
		1256	our @POSTPONE;
		1257
		1258	sub _postpone_exec {
		1259	undef $POSTPONE_W;
		1260
		1261	&{ shift @POSTPONE }
		1262	while @POSTPONE;
		1263	}
		1264
		1265	sub postpone(&) {
		1266	push @POSTPONE, shift;
		1267
		1268	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1269
		1270	()
		1271	}
		1272
1205	my @models = (	1273	our @models = (
1206	[EV:: => AnyEvent::Impl::EV:: , 1],	1274	[EV:: => AnyEvent::Impl::EV:: , 1],
1207	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1275	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1208	# everything below here will not (normally) be autoprobed	1276	# everything below here will not (normally) be autoprobed
1209	# as the pureperl backend should work everywhere	1277	# as the pure perl backend should work everywhere
1210	# and is usually faster	1278	# and is usually faster
1211	[Event:: => AnyEvent::Impl::Event::, 1],	1279	[Event:: => AnyEvent::Impl::Event::, 1],
1212	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1280	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1213	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1281	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1214	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1282	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1215	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1283	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1216	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1284	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1217	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1285	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1218	[Wx:: => AnyEvent::Impl::POE::],	1286	[Wx:: => AnyEvent::Impl::POE::],
1219	[Prima:: => AnyEvent::Impl::POE::],	1287	[Prima:: => AnyEvent::Impl::POE::],
1220	# IO::Async is just too broken - we would need workarounds for its	1288	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1221	# byzantine signal and broken child handling, among others.	1289	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1222	# IO::Async is rather hard to detect, as it doesn't have any	1290	[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	);	1291	);
1229		1292
1230	our %method = map +($_ => 1),	1293	# all autoloaded methods reserve the complete glob, not just the method slot.
		1294	# due to bugs in perls method cache implementation.
1231	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1295	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		1296
1249	sub detect() {	1297	sub detect() {
		1298	local $!; # for good measure
		1299	local $SIG{__DIE__}; # we use eval
		1300
1250	# free some memory	1301	# free some memory
1251	*detect = sub () { $MODEL };	1302	*detect = sub () { $MODEL };
		1303	# undef &func doesn't correctly update the method cache. grmbl.
		1304	# so we delete the whole glob. grmbl.
		1305	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1306	# a glob with an active sub. hrm. i hope it works, but perl is
		1307	# usually buggy in this department. sigh.
		1308	delete @{"AnyEvent::"}{@methods};
		1309	undef @methods;
1252		1310
1253	local $!; # for good measure
1254	local $SIG{__DIE__};
1255
1256	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1311	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1257	my $model = "AnyEvent::Impl::$1";	1312	my $model = $1;
		1313	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1258	if (eval "require $model") {	1314	if (eval "require $model") {
1259	$MODEL = $model;	1315	$MODEL = $model;
1260	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1316	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1261	} else {	1317	} else {
1262	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1318	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
…		…
1295	$MODEL	1351	$MODEL
1296	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1352	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1297	}	1353	}
1298	}	1354	}
1299		1355
1300	@models = (); # free probe data	1356	# free memory only needed for probing
		1357	undef @models;
		1358	undef @REGISTRY;
1301		1359
1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1360	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1303	unshift @ISA, $MODEL;	1361	unshift @ISA, $MODEL;
1304		1362
1305	# now nuke some methods that are overridden by the backend.	1363	# now nuke some methods that are overridden by the backend.
1306	# SUPER is not allowed.	1364	# SUPER usage is not allowed in these.
1307	for (qw(time signal child idle)) {	1365	for (qw(time signal child idle)) {
1308	undef &{"AnyEvent::Base::$_"}	1366	undef &{"AnyEvent::Base::$_"}
1309	if defined &{"$MODEL\::$_"};	1367	if defined &{"$MODEL\::$_"};
1310	}	1368	}
1311		1369
1312	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1370	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1371	require AnyEvent::Strict;
		1372	}
		1373
		1374	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1375	require AnyEvent::Debug;
		1376	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1377	}
		1378
		1379	if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1380	require AnyEvent::Socket;
		1381	require AnyEvent::Debug;
		1382
		1383	my ($host, $service) = AnyEvent::Socket::parse_hostport ($ENV{PERL_ANYEVENT_DEBUG_SHELL});
		1384	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1385	}
1313		1386
1314	(shift @post_detect)->() while @post_detect;	1387	(shift @post_detect)->() while @post_detect;
		1388	undef @post_detect;
1315		1389
1316	*post_detect = sub(&) {	1390	*post_detect = sub(&) {
1317	shift->();	1391	shift->();
1318		1392
1319	undef	1393	undef
1320	};	1394	};
1321		1395
1322	$MODEL	1396	$MODEL
1323	}	1397	}
1324		1398
1325	sub AUTOLOAD {	1399	for my $name (@methods) {
1326	(my $func = $AUTOLOAD) =~ s/.*://;	1400	*$name = sub {
1327
1328	$method{$func}
1329	or Carp::croak "$func: not a valid AnyEvent class method";
1330
1331	detect;	1401	detect;
1332		1402	# we use goto because
1333	my $class = shift;	1403	# a) it makes the thunk more transparent
1334	$class->$func (@_);	1404	# b) it allows us to delete the thunk later
		1405	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1406	};
1335	}	1407	}
1336		1408
1337	# utility function to dup a filehandle. this is used by many backends	1409	# utility function to dup a filehandle. this is used by many backends
1338	# to support binding more than one watcher per filehandle (they usually	1410	# 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).	1411	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1363		1435
1364	package AE;	1436	package AE;
1365		1437
1366	our $VERSION = $AnyEvent::VERSION;	1438	our $VERSION = $AnyEvent::VERSION;
1367		1439
		1440	sub _reset() {
		1441	eval q{
1368	# fall back to the main API by default - backends and AnyEvent::Base	1442	# fall back to the main API by default - backends and AnyEvent::Base
1369	# implementations can overwrite these.	1443	# implementations can overwrite these.
1370		1444
1371	sub io($$$) {	1445	sub io($$$) {
1372	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1446	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1373	}	1447	}
1374		1448
1375	sub timer($$$) {	1449	sub timer($$$) {
1376	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1450	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1377	}	1451	}
1378		1452
1379	sub signal($$) {	1453	sub signal($$) {
1380	AnyEvent->signal (signal => $_[0], cb => $_[1])	1454	AnyEvent->signal (signal => $_[0], cb => $_[1])
1381	}	1455	}
1382		1456
1383	sub child($$) {	1457	sub child($$) {
1384	AnyEvent->child (pid => $_[0], cb => $_[1])	1458	AnyEvent->child (pid => $_[0], cb => $_[1])
1385	}	1459	}
1386		1460
1387	sub idle($) {	1461	sub idle($) {
1388	AnyEvent->idle (cb => $_[0])	1462	AnyEvent->idle (cb => $_[0]);
1389	}	1463	}
1390		1464
1391	sub cv(;&) {	1465	sub cv(;&) {
1392	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1466	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1393	}	1467	}
1394		1468
1395	sub now() {	1469	sub now() {
1396	AnyEvent->now	1470	AnyEvent->now
1397	}	1471	}
1398		1472
1399	sub now_update() {	1473	sub now_update() {
1400	AnyEvent->now_update	1474	AnyEvent->now_update
1401	}	1475	}
1402		1476
1403	sub time() {	1477	sub time() {
1404	AnyEvent->time	1478	AnyEvent->time
		1479	}
		1480
		1481	*postpone = \&AnyEvent::postpone;
		1482	};
		1483	die if $@;
1405	}	1484	}
		1485
		1486	BEGIN { _reset }
1406		1487
1407	package AnyEvent::Base;	1488	package AnyEvent::Base;
1408		1489
1409	# default implementations for many methods	1490	# default implementations for many methods
1410		1491
…		…
1429		1510
1430	*now = \&time;	1511	*now = \&time;
1431		1512
1432	sub now_update { }	1513	sub now_update { }
1433		1514
		1515	sub _poll {
		1516	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1517	}
		1518
1434	# default implementation for ->condvar	1519	# default implementation for ->condvar
		1520	# in fact, the default should not be overwritten
1435		1521
1436	sub condvar {	1522	sub condvar {
1437	eval q{ # poor man's autoloading {}	1523	eval q{ # poor man's autoloading {}
1438	*condvar = sub {	1524	*condvar = sub {
1439	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1525	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1609	: sysread $SIGPIPE_R, (my $dummy), 9;	1695	: sysread $SIGPIPE_R, (my $dummy), 9;
1610		1696
1611	while (%SIG_EV) {	1697	while (%SIG_EV) {
1612	for (keys %SIG_EV) {	1698	for (keys %SIG_EV) {
1613	delete $SIG_EV{$_};	1699	delete $SIG_EV{$_};
1614	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1700	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1615	}	1701	}
1616	}	1702	}
1617	};	1703	};
1618	};	1704	};
1619	die if $@;	1705	die if $@;
…		…
1624	# default implementation for ->child	1710	# default implementation for ->child
1625		1711
1626	our %PID_CB;	1712	our %PID_CB;
1627	our $CHLD_W;	1713	our $CHLD_W;
1628	our $CHLD_DELAY_W;	1714	our $CHLD_DELAY_W;
1629	our $WNOHANG;
1630		1715
1631	# used by many Impl's	1716	# used by many Impl's
1632	sub _emit_childstatus($$) {	1717	sub _emit_childstatus($$) {
1633	my (undef, $rpid, $rstatus) = @_;	1718	my (undef, $rpid, $rstatus) = @_;
1634		1719
…		…
1641	eval q{ # poor man's autoloading {}	1726	eval q{ # poor man's autoloading {}
1642	*_sigchld = sub {	1727	*_sigchld = sub {
1643	my $pid;	1728	my $pid;
1644		1729
1645	AnyEvent->_emit_childstatus ($pid, $?)	1730	AnyEvent->_emit_childstatus ($pid, $?)
1646	while ($pid = waitpid -1, $WNOHANG) > 0;	1731	while ($pid = waitpid -1, WNOHANG) > 0;
1647	};	1732	};
1648		1733
1649	*child = sub {	1734	*child = sub {
1650	my (undef, %arg) = @_;	1735	my (undef, %arg) = @_;
1651		1736
1652	defined (my $pid = $arg{pid} + 0)	1737	my $pid = $arg{pid};
1653	or Carp::croak "required option 'pid' is missing";	1738	my $cb = $arg{cb};
1654		1739
1655	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1740	$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		1741
1662	unless ($CHLD_W) {	1742	unless ($CHLD_W) {
1663	$CHLD_W = AE::signal CHLD => \&_sigchld;	1743	$CHLD_W = AE::signal CHLD => \&_sigchld;
1664	# child could be a zombie already, so make at least one round	1744	# child could be a zombie already, so make at least one round
1665	&_sigchld;	1745	&_sigchld;
1666	}	1746	}
1667		1747
1668	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1748	bless [$pid, $cb+0], "AnyEvent::Base::child"
1669	};	1749	};
1670		1750
1671	*AnyEvent::Base::child::DESTROY = sub {	1751	*AnyEvent::Base::child::DESTROY = sub {
1672	my ($pid, $cb) = @{$_[0]};	1752	my ($pid, $icb) = @{$_[0]};
1673		1753
1674	delete $PID_CB{$pid}{$cb};	1754	delete $PID_CB{$pid}{$icb};
1675	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1755	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1676		1756
1677	undef $CHLD_W unless keys %PID_CB;	1757	undef $CHLD_W unless keys %PID_CB;
1678	};	1758	};
1679	};	1759	};
…		…
1692		1772
1693	my ($cb, $w, $rcb) = $arg{cb};	1773	my ($cb, $w, $rcb) = $arg{cb};
1694		1774
1695	$rcb = sub {	1775	$rcb = sub {
1696	if ($cb) {	1776	if ($cb) {
1697	$w = _time;	1777	$w = AE::time;
1698	&$cb;	1778	&$cb;
1699	$w = _time - $w;	1779	$w = AE::time - $w;
1700		1780
1701	# never use more then 50% of the time for the idle watcher,	1781	# never use more then 50% of the time for the idle watcher,
1702	# within some limits	1782	# within some limits
1703	$w = 0.0001 if $w < 0.0001;	1783	$w = 0.0001 if $w < 0.0001;
1704	$w = 5 if $w > 5;	1784	$w = 5 if $w > 5;
…		…
1751		1831
1752	sub _send {	1832	sub _send {
1753	# nop	1833	# nop
1754	}	1834	}
1755		1835
		1836	sub _wait {
		1837	AnyEvent->_poll until $_[0]{_ae_sent};
		1838	}
		1839
1756	sub send {	1840	sub send {
1757	my $cv = shift;	1841	my $cv = shift;
1758	$cv->{_ae_sent} = [@_];	1842	$cv->{_ae_sent} = [@_];
1759	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1843	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1760	$cv->_send;	1844	$cv->_send;
…		…
1767		1851
1768	sub ready {	1852	sub ready {
1769	$_[0]{_ae_sent}	1853	$_[0]{_ae_sent}
1770	}	1854	}
1771		1855
1772	sub _wait {
1773	$WAITING
1774	and !$_[0]{_ae_sent}
1775	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1776
1777	local $WAITING = 1;
1778	AnyEvent->one_event while !$_[0]{_ae_sent};
1779	}
1780
1781	sub recv {	1856	sub recv {
		1857	unless ($_[0]{_ae_sent}) {
		1858	$WAITING
		1859	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1860
		1861	local $WAITING = 1;
1782	$_[0]->_wait;	1862	$_[0]->_wait;
		1863	}
1783		1864
1784	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1865	$_[0]{_ae_croak}
1785	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1866	and Carp::croak $_[0]{_ae_croak};
		1867
		1868	wantarray
		1869	? @{ $_[0]{_ae_sent} }
		1870	: $_[0]{_ae_sent}[0]
1786	}	1871	}
1787		1872
1788	sub cb {	1873	sub cb {
1789	my $cv = shift;	1874	my $cv = shift;
1790		1875
…		…
1806	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1891	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1807	}	1892	}
1808		1893
1809	# undocumented/compatibility with pre-3.4	1894	# undocumented/compatibility with pre-3.4
1810	*broadcast = \&send;	1895	*broadcast = \&send;
1811	*wait = \&_wait;	1896	*wait = \&recv;
1812		1897
1813	=head1 ERROR AND EXCEPTION HANDLING	1898	=head1 ERROR AND EXCEPTION HANDLING
1814		1899
1815	In general, AnyEvent does not do any error handling - it relies on the	1900	In general, AnyEvent does not do any error handling - it relies on the
1816	caller to do that if required. The L<AnyEvent::Strict> module (see also	1901	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1868	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	1953	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1869	>>, it is definitely recommended to keep it off in production. Keeping	1954	>>, it is definitely recommended to keep it off in production. Keeping
1870	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1955	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1871	can be very useful, however.	1956	can be very useful, however.
1872		1957
		1958	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		1959
		1960	If this env variable is set, then its contents will be
		1961	interpreted by C<AnyEvent::Socket::parse_hostport> and an
		1962	C<AnyEvent::Debug::shell> is bound on that port. The shell object is saved
		1963	in C<$AnyEvent::Debug::SHELL>.
		1964
		1965	For example, to bind a debug shell on a unix domain socket in
		1966	F</tmp/debug.sock>, you could use this:
		1967
		1968	PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug.sock perlprog
		1969
		1970	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		1971
		1972	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		1973	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		1974
1873	=item C<PERL_ANYEVENT_MODEL>	1975	=item C<PERL_ANYEVENT_MODEL>
1874		1976
1875	This can be used to specify the event model to be used by AnyEvent, before	1977	This can be used to specify the event model to be used by AnyEvent, before
1876	auto detection and -probing kicks in. It must be a string consisting	1978	auto detection and -probing kicks in.
1877	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1979
		1980	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		1981	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1878	and the resulting module name is loaded and if the load was successful,	1982	resulting module name is loaded and - if the load was successful - used as
1879	used as event model. If it fails to load AnyEvent will proceed with	1983	event model backend. If it fails to load then AnyEvent will proceed with
1880	auto detection and -probing.	1984	auto detection and -probing.
1881		1985
1882	This functionality might change in future versions.	1986	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		1987	nothing gets prepended and the module name is used as-is (hint: C<::> at
		1988	the end of a string designates a module name and quotes it appropriately).
1883		1989
1884	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1990	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1885	could start your program like this:	1991	could start your program like this:
1886		1992
1887	PERL_ANYEVENT_MODEL=Perl perl ...	1993	PERL_ANYEVENT_MODEL=Perl perl ...
1888		1994
1889	=item C<PERL_ANYEVENT_PROTOCOLS>	1995	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2588		2694
2589	=item L<Time::HiRes>	2695	=item L<Time::HiRes>
2590		2696
2591	This module is part of perl since release 5.008. It will be used when the	2697	This module is part of perl since release 5.008. It will be used when the
2592	chosen event library does not come with a timing source of its own. The	2698	chosen event library does not come with a timing source of its own. The
2593	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2699	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2594	try to use a monotonic clock for timing stability.	2700	try to use a monotonic clock for timing stability.
2595		2701
2596	=back	2702	=back
2597		2703
2598		2704
…		…
2666		2772
2667	FAQ: L<AnyEvent::FAQ>.	2773	FAQ: L<AnyEvent::FAQ>.
2668		2774
2669	Utility functions: L<AnyEvent::Util>.	2775	Utility functions: L<AnyEvent::Util>.
2670		2776
2671	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2777	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2672	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2778	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2673		2779
2674	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2780	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2675	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2781	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2676	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2782	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2677	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2783	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.338 by root, Tue Nov 23 04:45:59 2010 UTC vs. Revision 1.358 by root, Sat Aug 13 02:35:32 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.338 by root, Tue Nov 23 04:45:59 2010 UTC vs.
Revision 1.358 by root, Sat Aug 13 02:35:32 2011 UTC