[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.356 by root, Fri Aug 12 18:41:25 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
…		…
1008	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009	# as soon as it is	1006	# as soon as it is
1010	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011	}	1008	}
1012		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
1013	=back	1050	=back
1014		1051
1015	=head1 WHAT TO DO IN A MODULE	1052	=head1 WHAT TO DO IN A MODULE
1016		1053
1017	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
…		…
1050	modules might create watchers when they are loaded, and AnyEvent will	1087	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	1088	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.	1089	might choose the wrong one unless you load the correct one yourself.
1053		1090
1054	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
1055	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1092	C<AnyEvent::Loop> module, which gives you similar behaviour
1056	everywhere, but letting AnyEvent chose the model is generally better.	1093	everywhere, but letting AnyEvent chose the model is generally better.
1057		1094
1058	=head2 MAINLOOP EMULATION	1095	=head2 MAINLOOP EMULATION
1059		1096
1060	Sometimes (often for short test scripts, or even standalone programs who	1097	Sometimes (often for short test scripts, or even standalone programs who
…		…
1155		1192
1156	package AnyEvent;	1193	package AnyEvent;
1157		1194
1158	# basically a tuned-down version of common::sense	1195	# basically a tuned-down version of common::sense
1159	sub common_sense {	1196	sub common_sense {
1160	# from common:.sense 3.3	1197	# from common:.sense 3.4
1161	${^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";
1162	# 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)
1163	$^H \|= 0x00000600;	1200	$^H \|= 0x00000600;
1164	}	1201	}
1165		1202
1166	BEGIN { AnyEvent::common_sense }	1203	BEGIN { AnyEvent::common_sense }
1167		1204
1168	use Carp ();	1205	use Carp ();
1169		1206
1170	our $VERSION = '5.271';	1207	our $VERSION = '5.34';
1171	our $MODEL;	1208	our $MODEL;
1172		1209
1173	our $AUTOLOAD;	1210	our $AUTOLOAD;
1174	our @ISA;	1211	our @ISA;
1175		1212
…		…
1198	$PROTOCOL{$_} = ++$idx	1235	$PROTOCOL{$_} = ++$idx
1199	for reverse split /\s,\s/,	1236	for reverse split /\s,\s/,
1200	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1237	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1201	}	1238	}
1202		1239
		1240	our @post_detect;
		1241
		1242	sub post_detect(&) {
		1243	my ($cb) = @_;
		1244
		1245	push @post_detect, $cb;
		1246
		1247	defined wantarray
		1248	? bless \$cb, "AnyEvent::Util::postdetect"
		1249	: ()
		1250	}
		1251
		1252	sub AnyEvent::Util::postdetect::DESTROY {
		1253	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1254	}
		1255
		1256	our $POSTPONE_W;
		1257	our @POSTPONE;
		1258
		1259	sub _postpone_exec {
		1260	undef $POSTPONE_W;
		1261
		1262	&{ shift @POSTPONE }
		1263	while @POSTPONE;
		1264	}
		1265
		1266	sub postpone(&) {
		1267	push @POSTPONE, shift;
		1268
		1269	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1270
		1271	()
		1272	}
		1273
1203	my @models = (	1274	our @models = (
1204	[EV:: => AnyEvent::Impl::EV:: , 1],	1275	[EV:: => AnyEvent::Impl::EV:: , 1],
1205	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1276	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1206	# everything below here will not (normally) be autoprobed	1277	# everything below here will not (normally) be autoprobed
1207	# as the pureperl backend should work everywhere	1278	# as the pure perl backend should work everywhere
1208	# and is usually faster	1279	# and is usually faster
1209	[Event:: => AnyEvent::Impl::Event::, 1],	1280	[Event:: => AnyEvent::Impl::Event::, 1],
1210	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1281	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1211	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1282	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1212	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1283	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1213	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1284	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1214	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1285	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1215	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1286	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1216	[Wx:: => AnyEvent::Impl::POE::],	1287	[Wx:: => AnyEvent::Impl::POE::],
1217	[Prima:: => AnyEvent::Impl::POE::],	1288	[Prima:: => AnyEvent::Impl::POE::],
1218	# IO::Async is just too broken - we would need workarounds for its	1289	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1219	# byzantine signal and broken child handling, among others.	1290	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1220	# IO::Async is rather hard to detect, as it doesn't have any	1291	[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	);	1292	);
1227
1228	our %method = map +($_ => 1),
1229	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
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		1293
1247	sub detect() {	1294	sub detect() {
1248	# free some memory	1295	# free some memory
1249	*detect = sub () { $MODEL };	1296	*detect = sub () { $MODEL };
1250		1297
1251	local $!; # for good measure	1298	local $!; # for good measure
1252	local $SIG{__DIE__};	1299	local $SIG{__DIE__};
1253		1300
1254	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1301	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1255	my $model = "AnyEvent::Impl::$1";	1302	my $model = $1;
		1303	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1256	if (eval "require $model") {	1304	if (eval "require $model") {
1257	$MODEL = $model;	1305	$MODEL = $model;
1258	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1306	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1259	} else {	1307	} else {
1260	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1308	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
…		…
1289	last;	1337	last;
1290	}	1338	}
1291	}	1339	}
1292		1340
1293	$MODEL	1341	$MODEL
1294	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1342	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1295	}	1343	}
1296	}	1344	}
1297		1345
1298	@models = (); # free probe data	1346	# free memory only needed for probing
		1347	undef @models;
		1348	undef @REGISTRY;
1299		1349
1300	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1350	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1301	unshift @ISA, $MODEL;	1351	unshift @ISA, $MODEL;
1302		1352
1303	# now nuke some methods that are overriden by the backend.	1353	# now nuke some methods that are overridden by the backend.
1304	# SUPER is not allowed.	1354	# SUPER usage is not allowed in these.
1305	for (qw(time signal child idle)) {	1355	for (qw(time signal child idle)) {
1306	undef &{"AnyEvent::Base::$_"}	1356	undef &{"AnyEvent::Base::$_"}
1307	if defined &{"$MODEL\::$_"};	1357	if defined &{"$MODEL\::$_"};
1308	}	1358	}
1309		1359
1310	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1360	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1361	eval { require AnyEvent::Strict };
		1362	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
		1363	if $@ && $VERBOSE;
		1364	}
1311		1365
1312	(shift @post_detect)->() while @post_detect;	1366	(shift @post_detect)->() while @post_detect;
		1367	undef @post_detect;
1313		1368
1314	*post_detect = sub(&) {	1369	*post_detect = sub(&) {
1315	shift->();	1370	shift->();
1316		1371
1317	undef	1372	undef
1318	};	1373	};
1319		1374
		1375	# recover a few more bytes
		1376	postpone {
		1377	undef &AUTOLOAD;
		1378	};
		1379
1320	$MODEL	1380	$MODEL
1321	}	1381	}
		1382
		1383	our %method = map +($_ => 1),
		1384	qw(io timer time now now_update signal child idle condvar DESTROY);
1322		1385
1323	sub AUTOLOAD {	1386	sub AUTOLOAD {
1324	(my $func = $AUTOLOAD) =~ s/.*://;	1387	(my $func = $AUTOLOAD) =~ s/.*://;
1325		1388
1326	$method{$func}	1389	$method{$func}
1327	or Carp::croak "$func: not a valid AnyEvent class method";	1390	or Carp::croak "$func: not a valid AnyEvent class method";
		1391
		1392	# free some memory
		1393	undef %method;
1328		1394
1329	detect;	1395	detect;
1330		1396
1331	my $class = shift;	1397	my $class = shift;
1332	$class->$func (@_);	1398	$class->$func (@_);
…		…
1361		1427
1362	package AE;	1428	package AE;
1363		1429
1364	our $VERSION = $AnyEvent::VERSION;	1430	our $VERSION = $AnyEvent::VERSION;
1365		1431
		1432
		1433	sub _reset() {
		1434	eval q{
1366	# fall back to the main API by default - backends and AnyEvent::Base	1435	# fall back to the main API by default - backends and AnyEvent::Base
1367	# implementations can overwrite these.	1436	# implementations can overwrite these.
1368		1437
1369	sub io($$$) {	1438	sub io($$$) {
1370	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1439	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1371	}	1440	}
1372		1441
1373	sub timer($$$) {	1442	sub timer($$$) {
1374	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1443	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1375	}	1444	}
1376		1445
1377	sub signal($$) {	1446	sub signal($$) {
1378	AnyEvent->signal (signal => $_[0], cb => $_[1])	1447	AnyEvent->signal (signal => $_[0], cb => $_[1])
1379	}	1448	}
1380		1449
1381	sub child($$) {	1450	sub child($$) {
1382	AnyEvent->child (pid => $_[0], cb => $_[1])	1451	AnyEvent->child (pid => $_[0], cb => $_[1])
1383	}	1452	}
1384		1453
1385	sub idle($) {	1454	sub idle($) {
1386	AnyEvent->idle (cb => $_[0])	1455	AnyEvent->idle (cb => $_[0])
1387	}	1456	}
1388		1457
1389	sub cv(;&) {	1458	sub cv(;&) {
1390	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1459	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1391	}	1460	}
1392		1461
1393	sub now() {	1462	sub now() {
1394	AnyEvent->now	1463	AnyEvent->now
1395	}	1464	}
1396		1465
1397	sub now_update() {	1466	sub now_update() {
1398	AnyEvent->now_update	1467	AnyEvent->now_update
1399	}	1468	}
1400		1469
1401	sub time() {	1470	sub time() {
1402	AnyEvent->time	1471	AnyEvent->time
		1472	}
		1473
		1474	*postpone = \&AnyEvent::postpone;
		1475	};
		1476	die if $@;
1403	}	1477	}
		1478
		1479	BEGIN { _reset }
1404		1480
1405	package AnyEvent::Base;	1481	package AnyEvent::Base;
1406		1482
1407	# default implementations for many methods	1483	# default implementations for many methods
1408		1484
…		…
1427		1503
1428	*now = \&time;	1504	*now = \&time;
1429		1505
1430	sub now_update { }	1506	sub now_update { }
1431		1507
		1508	sub _poll {
		1509	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1510	}
		1511
1432	# default implementation for ->condvar	1512	# default implementation for ->condvar
		1513	# in fact, the default should not be overwritten
1433		1514
1434	sub condvar {	1515	sub condvar {
1435	eval q{ # poor man's autoloading {}	1516	eval q{ # poor man's autoloading {}
1436	*condvar = sub {	1517	*condvar = sub {
1437	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1518	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1607	: sysread $SIGPIPE_R, (my $dummy), 9;	1688	: sysread $SIGPIPE_R, (my $dummy), 9;
1608		1689
1609	while (%SIG_EV) {	1690	while (%SIG_EV) {
1610	for (keys %SIG_EV) {	1691	for (keys %SIG_EV) {
1611	delete $SIG_EV{$_};	1692	delete $SIG_EV{$_};
1612	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1693	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1613	}	1694	}
1614	}	1695	}
1615	};	1696	};
1616	};	1697	};
1617	die if $@;	1698	die if $@;
…		…
1622	# default implementation for ->child	1703	# default implementation for ->child
1623		1704
1624	our %PID_CB;	1705	our %PID_CB;
1625	our $CHLD_W;	1706	our $CHLD_W;
1626	our $CHLD_DELAY_W;	1707	our $CHLD_DELAY_W;
1627	our $WNOHANG;
1628		1708
1629	# used by many Impl's	1709	# used by many Impl's
1630	sub _emit_childstatus($$) {	1710	sub _emit_childstatus($$) {
1631	my (undef, $rpid, $rstatus) = @_;	1711	my (undef, $rpid, $rstatus) = @_;
1632		1712
…		…
1639	eval q{ # poor man's autoloading {}	1719	eval q{ # poor man's autoloading {}
1640	*_sigchld = sub {	1720	*_sigchld = sub {
1641	my $pid;	1721	my $pid;
1642		1722
1643	AnyEvent->_emit_childstatus ($pid, $?)	1723	AnyEvent->_emit_childstatus ($pid, $?)
1644	while ($pid = waitpid -1, $WNOHANG) > 0;	1724	while ($pid = waitpid -1, WNOHANG) > 0;
1645	};	1725	};
1646		1726
1647	*child = sub {	1727	*child = sub {
1648	my (undef, %arg) = @_;	1728	my (undef, %arg) = @_;
1649		1729
1650	defined (my $pid = $arg{pid} + 0)	1730	my $pid = $arg{pid};
1651	or Carp::croak "required option 'pid' is missing";	1731	my $cb = $arg{cb};
1652		1732
1653	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1733	$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		1734
1660	unless ($CHLD_W) {	1735	unless ($CHLD_W) {
1661	$CHLD_W = AE::signal CHLD => \&_sigchld;	1736	$CHLD_W = AE::signal CHLD => \&_sigchld;
1662	# child could be a zombie already, so make at least one round	1737	# child could be a zombie already, so make at least one round
1663	&_sigchld;	1738	&_sigchld;
1664	}	1739	}
1665		1740
1666	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1741	bless [$pid, $cb+0], "AnyEvent::Base::child"
1667	};	1742	};
1668		1743
1669	*AnyEvent::Base::child::DESTROY = sub {	1744	*AnyEvent::Base::child::DESTROY = sub {
1670	my ($pid, $cb) = @{$_[0]};	1745	my ($pid, $icb) = @{$_[0]};
1671		1746
1672	delete $PID_CB{$pid}{$cb};	1747	delete $PID_CB{$pid}{$icb};
1673	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1748	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1674		1749
1675	undef $CHLD_W unless keys %PID_CB;	1750	undef $CHLD_W unless keys %PID_CB;
1676	};	1751	};
1677	};	1752	};
…		…
1690		1765
1691	my ($cb, $w, $rcb) = $arg{cb};	1766	my ($cb, $w, $rcb) = $arg{cb};
1692		1767
1693	$rcb = sub {	1768	$rcb = sub {
1694	if ($cb) {	1769	if ($cb) {
1695	$w = _time;	1770	$w = AE::time;
1696	&$cb;	1771	&$cb;
1697	$w = _time - $w;	1772	$w = AE::time - $w;
1698		1773
1699	# never use more then 50% of the time for the idle watcher,	1774	# never use more then 50% of the time for the idle watcher,
1700	# within some limits	1775	# within some limits
1701	$w = 0.0001 if $w < 0.0001;	1776	$w = 0.0001 if $w < 0.0001;
1702	$w = 5 if $w > 5;	1777	$w = 5 if $w > 5;
…		…
1725		1800
1726	package AnyEvent::CondVar;	1801	package AnyEvent::CondVar;
1727		1802
1728	our @ISA = AnyEvent::CondVar::Base::;	1803	our @ISA = AnyEvent::CondVar::Base::;
1729		1804
		1805	# only to be used for subclassing
		1806	sub new {
		1807	my $class = shift;
		1808	bless AnyEvent->condvar (@_), $class
		1809	}
		1810
1730	package AnyEvent::CondVar::Base;	1811	package AnyEvent::CondVar::Base;
1731		1812
1732	#use overload	1813	#use overload
1733	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1814	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1734	# fallback => 1;	1815	# fallback => 1;
…		…
1743		1824
1744	sub _send {	1825	sub _send {
1745	# nop	1826	# nop
1746	}	1827	}
1747		1828
		1829	sub _wait {
		1830	AnyEvent->_poll until $_[0]{_ae_sent};
		1831	}
		1832
1748	sub send {	1833	sub send {
1749	my $cv = shift;	1834	my $cv = shift;
1750	$cv->{_ae_sent} = [@_];	1835	$cv->{_ae_sent} = [@_];
1751	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1836	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1752	$cv->_send;	1837	$cv->_send;
…		…
1759		1844
1760	sub ready {	1845	sub ready {
1761	$_[0]{_ae_sent}	1846	$_[0]{_ae_sent}
1762	}	1847	}
1763		1848
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 {	1849	sub recv {
		1850	unless ($_[0]{_ae_sent}) {
		1851	$WAITING
		1852	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1853
		1854	local $WAITING = 1;
1774	$_[0]->_wait;	1855	$_[0]->_wait;
		1856	}
1775		1857
1776	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1858	$_[0]{_ae_croak}
1777	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1859	and Carp::croak $_[0]{_ae_croak};
		1860
		1861	wantarray
		1862	? @{ $_[0]{_ae_sent} }
		1863	: $_[0]{_ae_sent}[0]
1778	}	1864	}
1779		1865
1780	sub cb {	1866	sub cb {
1781	my $cv = shift;	1867	my $cv = shift;
1782		1868
…		…
1798	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1884	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1799	}	1885	}
1800		1886
1801	# undocumented/compatibility with pre-3.4	1887	# undocumented/compatibility with pre-3.4
1802	*broadcast = \&send;	1888	*broadcast = \&send;
1803	*wait = \&_wait;	1889	*wait = \&recv;
1804		1890
1805	=head1 ERROR AND EXCEPTION HANDLING	1891	=head1 ERROR AND EXCEPTION HANDLING
1806		1892
1807	In general, AnyEvent does not do any error handling - it relies on the	1893	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	1894	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1863	can be very useful, however.	1949	can be very useful, however.
1864		1950
1865	=item C<PERL_ANYEVENT_MODEL>	1951	=item C<PERL_ANYEVENT_MODEL>
1866		1952
1867	This can be used to specify the event model to be used by AnyEvent, before	1953	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	1954	auto detection and -probing kicks in.
1869	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1955
		1956	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		1957	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,	1958	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	1959	event model backend. If it fails to load then AnyEvent will proceed with
1872	auto detection and -probing.	1960	auto detection and -probing.
1873		1961
1874	This functionality might change in future versions.	1962	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		1963	nothing gets prepended and the module name is used as-is (hint: C<::> at
		1964	the end of a string designates a module name and quotes it appropriately).
1875		1965
1876	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1966	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1877	could start your program like this:	1967	could start your program like this:
1878		1968
1879	PERL_ANYEVENT_MODEL=Perl perl ...	1969	PERL_ANYEVENT_MODEL=Perl perl ...
1880		1970
1881	=item C<PERL_ANYEVENT_PROTOCOLS>	1971	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2580		2670
2581	=item L<Time::HiRes>	2671	=item L<Time::HiRes>
2582		2672
2583	This module is part of perl since release 5.008. It will be used when the	2673	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	2674	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	2675	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2586	try to use a monotonic clock for timing stability.	2676	try to use a monotonic clock for timing stability.
2587		2677
2588	=back	2678	=back
2589		2679
2590		2680
…		…
2652	pronounced).	2742	pronounced).
2653		2743
2654		2744
2655	=head1 SEE ALSO	2745	=head1 SEE ALSO
2656		2746
		2747	Tutorial/Introduction: L<AnyEvent::Intro>.
		2748
		2749	FAQ: L<AnyEvent::FAQ>.
		2750
2657	Utility functions: L<AnyEvent::Util>.	2751	Utility functions: L<AnyEvent::Util>.
2658		2752
2659	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2753	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>.	2754	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2661		2755
2662	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2756	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2757	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2758	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2759	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
…		…
2667	Non-blocking file handles, sockets, TCP clients and	2761	Non-blocking file handles, sockets, TCP clients and
2668	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2762	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669		2763
2670	Asynchronous DNS: L<AnyEvent::DNS>.	2764	Asynchronous DNS: L<AnyEvent::DNS>.
2671		2765
2672	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2766	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2673	L<Coro::Event>,
2674		2767
2675	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2768	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2676	L<AnyEvent::HTTP>.	2769	L<AnyEvent::HTTP>.
2677		2770
2678		2771
2679	=head1 AUTHOR	2772	=head1 AUTHOR
2680		2773

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.356 by root, Fri Aug 12 18:41:25 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.356 by root, Fri Aug 12 18:41:25 2011 UTC