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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.348 by root, Thu Feb 24 12:04:20 2011 UTC vs.
Revision 1.396 by root, Sat Mar 10 17:36:24 2012 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - the DBI of event loop programming	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6	and POE are various supported event loops/environments.	6	FLTK and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
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
…		…
415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's	415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416	pure perl implementation).	416	pure perl implementation).
417		417
418	=head3 Safe/Unsafe Signals	418	=head3 Safe/Unsafe Signals
419		419
420	Perl signals can be either "safe" (synchronous to opcode handling) or	420	Perl signals can be either "safe" (synchronous to opcode handling)
421	"unsafe" (asynchronous) - the former might get delayed indefinitely, the	421	or "unsafe" (asynchronous) - the former might delay signal delivery
422	latter might corrupt your memory.	422	indefinitely, the latter might corrupt your memory.
423		423
424	AnyEvent signal handlers are, in addition, synchronous to the event loop,	424	AnyEvent signal handlers are, in addition, synchronous to the event loop,
425	i.e. they will not interrupt your running perl program but will only be	425	i.e. they will not interrupt your running perl program but will only be
426	called as part of the normal event handling (just like timer, I/O etc.	426	called as part of the normal event handling (just like timer, I/O etc.
427	callbacks, too).	427	callbacks, too).
428		428
429	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
430		430
431	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	431	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
432	callbacks to signals in a generic way, which is a pity, as you cannot	432	attaching callbacks to signals in a generic way, which is a pity,
433	do race-free signal handling in perl, requiring C libraries for	433	as you cannot do race-free signal handling in perl, requiring
434	this. AnyEvent will try to do its best, which means in some cases,	434	C libraries for this. AnyEvent will try to do its best, which
435	signals will be delayed. The maximum time a signal might be delayed is	435	means in some cases, signals will be delayed. The maximum time
436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	436	a signal might be delayed is 10 seconds by default, but can
437	variable can be changed only before the first signal watcher is created,	437	be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
438	and should be left alone otherwise. This variable determines how often	438	C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
439	AnyEvent polls for signals (in case a wake-up was missed). Higher values	439	section for details.
440	will cause fewer spurious wake-ups, which is better for power and CPU
441	saving.
442		440
443	All these problems can be avoided by installing the optional	441	All these problems can be avoided by installing the optional
444	L<Async::Interrupt> module, which works with most event loops. It will not	442	L<Async::Interrupt> module, which works with most event loops. It will not
445	work with inherently broken event loops such as L<Event> or L<Event::Lib>	443	work with inherently broken event loops such as L<Event> or L<Event::Lib>
446	(and not with L<POE> currently, as POE does its own workaround with	444	(and not with L<POE> currently). For those, you just have to suffer the
447	one-second latency). For those, you just have to suffer the delays.	445	delays.
448		446
449	=head2 CHILD PROCESS WATCHERS	447	=head2 CHILD PROCESS WATCHERS
450		448
451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	449	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
452		450
…		…
482	thing in an AnyEvent program, you I<have> to create at least one	480	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	481	watcher before you C<fork> the child (alternatively, you can call
484	C<AnyEvent::detect>).	482	C<AnyEvent::detect>).
485		483
486	As most event loops do not support waiting for child events, they will be	484	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	485	emulated by AnyEvent in most cases, in which case the latency and race
488	mentioned in the description of signal watchers apply.	486	problems mentioned in the description of signal watchers apply.
489		487
490	Example: fork a process and wait for it	488	Example: fork a process and wait for it
491		489
492	my $done = AnyEvent->condvar;	490	my $done = AnyEvent->condvar;
493		491
…		…
860	use. If EV is not installed, then AnyEvent will fall back to its own	858	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	859	pure-perl implementation, which is available everywhere as it comes with
862	AnyEvent itself.	860	AnyEvent itself.
863		861
864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	863	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866		864
867	=item Backends that are transparently being picked up when they are used.	865	=item Backends that are transparently being picked up when they are used.
868		866
869	These will be used if they are already loaded when the first watcher	867	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	868	is created, in which case it is assumed that the application is using
…		…
878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	876	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879	AnyEvent::Impl::POE based on POE, very slow, some limitations.	877	AnyEvent::Impl::POE based on POE, very slow, some limitations.
880	AnyEvent::Impl::Irssi used when running within irssi.	878	AnyEvent::Impl::Irssi used when running within irssi.
881	AnyEvent::Impl::IOAsync based on IO::Async.	879	AnyEvent::Impl::IOAsync based on IO::Async.
882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.	880	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		881	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
883		882
884	=item Backends with special needs.	883	=item Backends with special needs.
885		884
886	Qt requires the Qt::Application to be instantiated first, but will	885	Qt requires the Qt::Application to be instantiated first, but will
887	otherwise be picked up automatically. As long as the main program	886	otherwise be picked up automatically. As long as the main program
…		…
932		931
933	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	932	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
934	if necessary. You should only call this function right before you would	933	if necessary. You should only call this function right before you would
935	have created an AnyEvent watcher anyway, that is, as late as possible at	934	have created an AnyEvent watcher anyway, that is, as late as possible at
936	runtime, and not e.g. during initialisation of your module.	935	runtime, and not e.g. during initialisation of your module.
		936
		937	The effect of calling this function is as if a watcher had been created
		938	(specifically, actions that happen "when the first watcher is created"
		939	happen when calling detetc as well).
937		940
938	If you need to do some initialisation before AnyEvent watchers are	941	If you need to do some initialisation before AnyEvent watchers are
939	created, use C<post_detect>.	942	created, use C<post_detect>.
940		943
941	=item $guard = AnyEvent::post_detect { BLOCK }	944	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1004	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1007	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1005	# as soon as it is	1008	# as soon as it is
1006	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1009	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1007	}	1010	}
1008		1011
		1012	=item AnyEvent::postpone { BLOCK }
		1013
		1014	Arranges for the block to be executed as soon as possible, but not before
		1015	the call itself returns. In practise, the block will be executed just
		1016	before the event loop polls for new events, or shortly afterwards.
		1017
		1018	This function never returns anything (to make the C<return postpone { ...
		1019	}> idiom more useful.
		1020
		1021	To understand the usefulness of this function, consider a function that
		1022	asynchronously does something for you and returns some transaction
		1023	object or guard to let you cancel the operation. For example,
		1024	C<AnyEvent::Socket::tcp_connect>:
		1025
		1026	# start a conenction attempt unless one is active
		1027	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1028	delete $self->{connect_guard};
		1029	...
		1030	};
		1031
		1032	Imagine that this function could instantly call the callback, for
		1033	example, because it detects an obvious error such as a negative port
		1034	number. Invoking the callback before the function returns causes problems
		1035	however: the callback will be called and will try to delete the guard
		1036	object. But since the function hasn't returned yet, there is nothing to
		1037	delete. When the function eventually returns it will assign the guard
		1038	object to C<< $self->{connect_guard} >>, where it will likely never be
		1039	deleted, so the program thinks it is still trying to connect.
		1040
		1041	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1042	callback directly on error:
		1043
		1044	$cb->(undef), return # signal error to callback, BAD!
		1045	if $some_error_condition;
		1046
		1047	It should use C<postpone>:
		1048
		1049	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1050	if $some_error_condition;
		1051
		1052	=item AnyEvent::log $level, $msg[, @args]
		1053
		1054	Log the given C<$msg> at the given C<$level>.
		1055
		1056	If L<AnyEvent::Log> is not loaded then this function makes a simple test
		1057	to see whether the message will be logged. If the test succeeds it will
		1058	load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
		1059	the L<AnyEvent::Log> documentation for details.
		1060
		1061	If the test fails it will simply return. Right now this happens when a
		1062	numerical loglevel is used and it is larger than the level specified via
		1063	C<$ENV{PERL_ANYEVENT_VERBOSE}>.
		1064
		1065	If you want to sprinkle loads of logging calls around your code, consider
		1066	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1067	which can reduce typing, codesize and can reduce the logging overhead
		1068	enourmously.
		1069
1009	=back	1070	=back
1010		1071
1011	=head1 WHAT TO DO IN A MODULE	1072	=head1 WHAT TO DO IN A MODULE
1012		1073
1013	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1074	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1046	modules might create watchers when they are loaded, and AnyEvent will	1107	modules might create watchers when they are loaded, and AnyEvent will
1047	decide on the event model to use as soon as it creates watchers, and it	1108	decide on the event model to use as soon as it creates watchers, and it
1048	might choose the wrong one unless you load the correct one yourself.	1109	might choose the wrong one unless you load the correct one yourself.
1049		1110
1050	You can chose to use a pure-perl implementation by loading the	1111	You can chose to use a pure-perl implementation by loading the
1051	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1112	C<AnyEvent::Loop> module, which gives you similar behaviour
1052	everywhere, but letting AnyEvent chose the model is generally better.	1113	everywhere, but letting AnyEvent chose the model is generally better.
1053		1114
1054	=head2 MAINLOOP EMULATION	1115	=head2 MAINLOOP EMULATION
1055		1116
1056	Sometimes (often for short test scripts, or even standalone programs who	1117	Sometimes (often for short test scripts, or even standalone programs who
…		…
1069		1130
1070		1131
1071	=head1 OTHER MODULES	1132	=head1 OTHER MODULES
1072		1133
1073	The following is a non-exhaustive list of additional modules that use	1134	The following is a non-exhaustive list of additional modules that use
1074	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1135	AnyEvent as a client and can therefore be mixed easily with other
1075	modules and other event loops in the same program. Some of the modules	1136	AnyEvent modules and other event loops in the same program. Some of the
1076	come as part of AnyEvent, the others are available via CPAN.	1137	modules come as part of AnyEvent, the others are available via CPAN (see
		1138	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1139	a longer non-exhaustive list), and the list is heavily biased towards
		1140	modules of the AnyEvent author himself :)
1077		1141
1078	=over 4	1142	=over 4
1079		1143
1080	=item L<AnyEvent::Util>	1144	=item L<AnyEvent::Util>
1081		1145
…		…
1101	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>	1165	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1102		1166
1103	Implement event-based interfaces to the protocols of the same name (for	1167	Implement event-based interfaces to the protocols of the same name (for
1104	the curious, IGS is the International Go Server and FCP is the Freenet	1168	the curious, IGS is the International Go Server and FCP is the Freenet
1105	Client Protocol).	1169	Client Protocol).
1106
1107	=item L<AnyEvent::Handle::UDP>
1108
1109	Here be danger!
1110
1111	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1112	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1113	its use of a stream-based API with a protocol that isn't streamable, that
1114	the only way to improve it is to delete it.
1115
1116	It features data corruption (but typically only under load) and general
1117	confusion. On top, the author is not only clueless about UDP but also
1118	fact-resistant - some gems of his understanding: "connect doesn't work
1119	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1120	packets", "I don't need to implement proper error checking as UDP doesn't
1121	support error checking" and so on - he doesn't even understand what's
1122	wrong with his module when it is explained to him.
1123
1124	=item L<AnyEvent::DBI>
1125
1126	Executes L<DBI> requests asynchronously in a proxy process for you,
1127	notifying you in an event-based way when the operation is finished.
1128		1170
1129	=item L<AnyEvent::AIO>	1171	=item L<AnyEvent::AIO>
1130		1172
1131	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1173	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1132	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1174	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1133	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based	1175	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1134	file I/O, and much more.	1176	file I/O, and much more.
1135		1177
		1178	=item L<AnyEvent::Filesys::Notify>
		1179
		1180	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1181	path changes (e.g. "watch this directory for new files", "watch this
		1182	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1183	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1184	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1185	fall back to blocking scans at regular intervals transparently on other
		1186	platforms, so it's about as portable as it gets.
		1187
		1188	(I haven't used it myself, but I haven't heard anybody complaining about
		1189	it yet).
		1190
		1191	=item L<AnyEvent::DBI>
		1192
		1193	Executes L<DBI> requests asynchronously in a proxy process for you,
		1194	notifying you in an event-based way when the operation is finished.
		1195
1136	=item L<AnyEvent::HTTPD>	1196	=item L<AnyEvent::HTTPD>
1137		1197
1138	A simple embedded webserver.	1198	A simple embedded webserver.
1139		1199
1140	=item L<AnyEvent::FastPing>	1200	=item L<AnyEvent::FastPing>
1141		1201
1142	The fastest ping in the west.	1202	The fastest ping in the west.
1143		1203
1144	=item L<Coro>	1204	=item L<Coro>
1145		1205
1146	Has special support for AnyEvent via L<Coro::AnyEvent>.	1206	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1207	to simply invert the flow control - don't call us, we will call you:
		1208
		1209	async {
		1210	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1211	print "5 seconds later!\n";
		1212
		1213	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1214	my $line = <STDIN>; # works for ttys
		1215
		1216	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1217	my ($body, $hdr) = Coro::rouse_wait;
		1218	};
1147		1219
1148	=back	1220	=back
1149		1221
1150	=cut	1222	=cut
1151		1223
…		…
1161		1233
1162	BEGIN { AnyEvent::common_sense }	1234	BEGIN { AnyEvent::common_sense }
1163		1235
1164	use Carp ();	1236	use Carp ();
1165		1237
1166	our $VERSION = '5.33';	1238	our $VERSION = '6.14';
1167	our $MODEL;	1239	our $MODEL;
1168
1169	our $AUTOLOAD;
1170	our @ISA;	1240	our @ISA;
1171
1172	our @REGISTRY;	1241	our @REGISTRY;
1173
1174	our $VERBOSE;	1242	our $VERBOSE;
		1243	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
		1244	our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} \|\| 10; # executes after the BEGIN block below (tainting!)
1175		1245
1176	BEGIN {	1246	BEGIN {
1177	require "AnyEvent/constants.pl";	1247	require "AnyEvent/constants.pl";
1178		1248
1179	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1249	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1180		1250
1181	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1251	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1182	if ${^TAINT};	1252	if ${^TAINT};
1183		1253
1184	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1254	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1255	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1185		1256
1186	}	1257	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1258	if ${^TAINT};
1187		1259
1188	our $MAX_SIGNAL_LATENCY = 10;	1260	# $ENV{PERL_ANYEVENT_xxx} now valid
1189		1261
1190	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1262	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1191		1263
1192	{
1193	my $idx;	1264	my $idx;
1194	$PROTOCOL{$_} = ++$idx	1265	$PROTOCOL{$_} = ++$idx
1195	for reverse split /\s,\s/,	1266	for reverse split /\s,\s/,
1196	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1267	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1197	}	1268	}
1198		1269
		1270	our @post_detect;
		1271
		1272	sub post_detect(&) {
		1273	my ($cb) = @_;
		1274
		1275	push @post_detect, $cb;
		1276
		1277	defined wantarray
		1278	? bless \$cb, "AnyEvent::Util::postdetect"
		1279	: ()
		1280	}
		1281
		1282	sub AnyEvent::Util::postdetect::DESTROY {
		1283	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1284	}
		1285
		1286	our $POSTPONE_W;
		1287	our @POSTPONE;
		1288
		1289	sub _postpone_exec {
		1290	undef $POSTPONE_W;
		1291
		1292	&{ shift @POSTPONE }
		1293	while @POSTPONE;
		1294	}
		1295
		1296	sub postpone(&) {
		1297	push @POSTPONE, shift;
		1298
		1299	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1300
		1301	()
		1302	}
		1303
		1304	sub log($$;@) {
		1305	# only load the big bloated module when we actually are about to log something
		1306	if ($_[0] <= ($VERBOSE \|\| 1)) { # also catches non-numeric levels(!) and fatal
		1307	local ($!, $@);
		1308	require AnyEvent::Log; # among other things, sets $VERBOSE to 9
		1309	# AnyEvent::Log overwrites this function
		1310	goto &log;
		1311	}
		1312
		1313	0 # not logged
		1314	}
		1315
		1316	sub _logger($;$) {
		1317	my ($level, $renabled) = @_;
		1318
		1319	$$renabled = $level <= $VERBOSE;
		1320
		1321	my $logger = [(caller)[0], $level, $renabled];
		1322
		1323	$AnyEvent::Log::LOGGER{$logger+0} = $logger;
		1324
		1325	# return unless defined wantarray;
		1326	#
		1327	# require AnyEvent::Util;
		1328	# my $guard = AnyEvent::Util::guard (sub {
		1329	# # "clean up"
		1330	# delete $LOGGER{$logger+0};
		1331	# });
		1332	#
		1333	# sub {
		1334	# return 0 unless $$renabled;
		1335	#
		1336	# $guard if 0; # keep guard alive, but don't cause runtime overhead
		1337	# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
		1338	# package AnyEvent::Log;
		1339	# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
		1340	# }
		1341	}
		1342
		1343	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1344	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1345	}
		1346
1199	my @models = (	1347	our @models = (
1200	[EV:: => AnyEvent::Impl::EV:: , 1],	1348	[EV:: => AnyEvent::Impl::EV::],
1201	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1349	[AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1202	# everything below here will not (normally) be autoprobed	1350	# everything below here will not (normally) be autoprobed
1203	# as the pureperl backend should work everywhere	1351	# as the pure perl backend should work everywhere
1204	# and is usually faster	1352	# and is usually faster
		1353	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1205	[Event:: => AnyEvent::Impl::Event::, 1],	1354	[Event:: => AnyEvent::Impl::Event::], # slow, stable
1206	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1355	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		1356	# everything below here should not be autoloaded
1207	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1357	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1358	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1359	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1360	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212	[Wx:: => AnyEvent::Impl::POE::],	1361	[Wx:: => AnyEvent::Impl::POE::],
1213	[Prima:: => AnyEvent::Impl::POE::],	1362	[Prima:: => AnyEvent::Impl::POE::],
1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1363	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1364	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1365	[FLTK:: => AnyEvent::Impl::FLTK::],
1216	);	1366	);
1217		1367
1218	our %method = map +($_ => 1),	1368	our @isa_hook;
		1369
		1370	sub _isa_set {
		1371	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1372
		1373	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1374	for 1 .. $#pkg;
		1375
		1376	grep $_ && $_->[1], @isa_hook
		1377	and AE::_reset ();
		1378	}
		1379
		1380	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1381	sub _isa_hook($$;$) {
		1382	my ($i, $pkg, $reset_ae) = @_;
		1383
		1384	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1385
		1386	_isa_set;
		1387	}
		1388
		1389	# all autoloaded methods reserve the complete glob, not just the method slot.
		1390	# due to bugs in perls method cache implementation.
1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1391	our @methods = qw(io timer time now now_update signal child idle condvar);
1220
1221	our @post_detect;
1222
1223	sub post_detect(&) {
1224	my ($cb) = @_;
1225
1226	push @post_detect, $cb;
1227
1228	defined wantarray
1229	? bless \$cb, "AnyEvent::Util::postdetect"
1230	: ()
1231	}
1232
1233	sub AnyEvent::Util::postdetect::DESTROY {
1234	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1235	}
1236		1392
1237	sub detect() {	1393	sub detect() {
		1394	return $MODEL if $MODEL; # some programs keep references to detect
		1395
		1396	# IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
		1397	# the author knows about the problems and what it does to AnyEvent as a whole
		1398	# (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
		1399	# anyway.
		1400	AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - that module is broken by\n"
		1401	. "design, abuses internals and breaks AnyEvent - will not continue."
		1402	if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
		1403
		1404	local $!; # for good measure
		1405	local $SIG{__DIE__}; # we use eval
		1406
1238	# free some memory	1407	# free some memory
1239	*detect = sub () { $MODEL };	1408	*detect = sub () { $MODEL };
		1409	# undef &func doesn't correctly update the method cache. grmbl.
		1410	# so we delete the whole glob. grmbl.
		1411	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1412	# a glob with an active sub. hrm. i hope it works, but perl is
		1413	# usually buggy in this department. sigh.
		1414	delete @{"AnyEvent::"}{@methods};
		1415	undef @methods;
1240		1416
1241	local $!; # for good measure
1242	local $SIG{__DIE__};
1243
1244	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1417	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245	my $model = "AnyEvent::Impl::$1";	1418	my $model = $1;
		1419	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246	if (eval "require $model") {	1420	if (eval "require $model") {
		1421	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1247	$MODEL = $model;	1422	$MODEL = $model;
1248	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1249	} else {	1423	} else {
1250	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1424	AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1251	}	1425	}
1252	}	1426	}
1253		1427
1254	# check for already loaded models	1428	# check for already loaded models
1255	unless ($MODEL) {	1429	unless ($MODEL) {
1256	for (@REGISTRY, @models) {	1430	for (@REGISTRY, @models) {
1257	my ($package, $model) = @$_;	1431	my ($package, $model) = @$_;
1258	if (${"$package\::VERSION"} > 0) {	1432	if (${"$package\::VERSION"} > 0) {
1259	if (eval "require $model") {	1433	if (eval "require $model") {
		1434	AnyEvent::log 7 => "autodetected model '$model', using it.";
1260	$MODEL = $model;	1435	$MODEL = $model;
1261	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1436	last;
		1437	} else {
		1438	AnyEvent::log 8 => "detected event loop $package, but cannot load '$model', skipping: $@";
		1439	}
		1440	}
		1441	}
		1442
		1443	unless ($MODEL) {
		1444	# try to autoload a model
		1445	for (@REGISTRY, @models) {
		1446	my ($package, $model) = @$_;
		1447	if (
		1448	eval "require $package"
		1449	and ${"$package\::VERSION"} > 0
		1450	and eval "require $model"
		1451	) {
		1452	AnyEvent::log 7 => "autoloaded model '$model', using it.";
		1453	$MODEL = $model;
1262	last;	1454	last;
1263	}	1455	}
1264	}	1456	}
1265	}
1266
1267	unless ($MODEL) {
1268	# try to autoload a model
1269	for (@REGISTRY, @models) {
1270	my ($package, $model, $autoload) = @$_;
1271	if (
1272	$autoload
1273	and eval "require $package"
1274	and ${"$package\::VERSION"} > 0
1275	and eval "require $model"
1276	) {
1277	$MODEL = $model;
1278	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1279	last;
1280	}
1281	}
1282		1457
1283	$MODEL	1458	$MODEL
1284	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1459	or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1285	}	1460	}
1286	}	1461	}
1287		1462
1288	@models = (); # free probe data	1463	# free memory only needed for probing
		1464	undef @models;
		1465	undef @REGISTRY;
1289		1466
1290	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1467	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291	unshift @ISA, $MODEL;
1292		1468
1293	# now nuke some methods that are overridden by the backend.	1469	# now nuke some methods that are overridden by the backend.
1294	# SUPER is not allowed.	1470	# SUPER usage is not allowed in these.
1295	for (qw(time signal child idle)) {	1471	for (qw(time signal child idle)) {
1296	undef &{"AnyEvent::Base::$_"}	1472	undef &{"AnyEvent::Base::$_"}
1297	if defined &{"$MODEL\::$_"};	1473	if defined &{"$MODEL\::$_"};
1298	}	1474	}
1299		1475
		1476	_isa_set;
		1477
		1478	# we're officially open!
		1479
1300	if ($ENV{PERL_ANYEVENT_STRICT}) {	1480	if ($ENV{PERL_ANYEVENT_STRICT}) {
1301	eval { require AnyEvent::Strict };	1481	require AnyEvent::Strict;
1302	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303	if $@ && $VERBOSE;
1304	}	1482	}
1305		1483
		1484	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1485	require AnyEvent::Debug;
		1486	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1487	}
		1488
		1489	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1490	require AnyEvent::Socket;
		1491	require AnyEvent::Debug;
		1492
		1493	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1494	$shell =~ s/\$\$/$$/g;
		1495
		1496	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1497	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1498	}
		1499
		1500	# now the anyevent environment is set up as the user told us to, so
		1501	# call the actual user code - post detects
		1502
1306	(shift @post_detect)->() while @post_detect;	1503	(shift @post_detect)->() while @post_detect;
		1504	undef @post_detect;
1307		1505
1308	*post_detect = sub(&) {	1506	*post_detect = sub(&) {
1309	shift->();	1507	shift->();
1310		1508
1311	undef	1509	undef
1312	};	1510	};
1313		1511
1314	$MODEL	1512	$MODEL
1315	}	1513	}
1316		1514
1317	sub AUTOLOAD {	1515	for my $name (@methods) {
1318	(my $func = $AUTOLOAD) =~ s/.*://;	1516	*$name = sub {
1319
1320	$method{$func}
1321	or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323	detect;	1517	detect;
1324		1518	# we use goto because
1325	my $class = shift;	1519	# a) it makes the thunk more transparent
1326	$class->$func (@_);	1520	# b) it allows us to delete the thunk later
		1521	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1522	};
1327	}	1523	}
1328		1524
1329	# utility function to dup a filehandle. this is used by many backends	1525	# utility function to dup a filehandle. this is used by many backends
1330	# to support binding more than one watcher per filehandle (they usually	1526	# to support binding more than one watcher per filehandle (they usually
1331	# allow only one watcher per fd, so we dup it to get a different one).	1527	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1355		1551
1356	package AE;	1552	package AE;
1357		1553
1358	our $VERSION = $AnyEvent::VERSION;	1554	our $VERSION = $AnyEvent::VERSION;
1359		1555
		1556	sub _reset() {
		1557	eval q{
1360	# fall back to the main API by default - backends and AnyEvent::Base	1558	# fall back to the main API by default - backends and AnyEvent::Base
1361	# implementations can overwrite these.	1559	# implementations can overwrite these.
1362		1560
1363	sub io($$$) {	1561	sub io($$$) {
1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1562	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365	}	1563	}
1366		1564
1367	sub timer($$$) {	1565	sub timer($$$) {
1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1566	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369	}	1567	}
1370		1568
1371	sub signal($$) {	1569	sub signal($$) {
1372	AnyEvent->signal (signal => $_[0], cb => $_[1])	1570	AnyEvent->signal (signal => $_[0], cb => $_[1])
1373	}	1571	}
1374		1572
1375	sub child($$) {	1573	sub child($$) {
1376	AnyEvent->child (pid => $_[0], cb => $_[1])	1574	AnyEvent->child (pid => $_[0], cb => $_[1])
1377	}	1575	}
1378		1576
1379	sub idle($) {	1577	sub idle($) {
1380	AnyEvent->idle (cb => $_[0])	1578	AnyEvent->idle (cb => $_[0]);
1381	}	1579	}
1382		1580
1383	sub cv(;&) {	1581	sub cv(;&) {
1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1582	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385	}	1583	}
1386		1584
1387	sub now() {	1585	sub now() {
1388	AnyEvent->now	1586	AnyEvent->now
1389	}	1587	}
1390		1588
1391	sub now_update() {	1589	sub now_update() {
1392	AnyEvent->now_update	1590	AnyEvent->now_update
1393	}	1591	}
1394		1592
1395	sub time() {	1593	sub time() {
1396	AnyEvent->time	1594	AnyEvent->time
		1595	}
		1596
		1597	*postpone = \&AnyEvent::postpone;
		1598	*log = \&AnyEvent::log;
		1599	};
		1600	die if $@;
1397	}	1601	}
		1602
		1603	BEGIN { _reset }
1398		1604
1399	package AnyEvent::Base;	1605	package AnyEvent::Base;
1400		1606
1401	# default implementations for many methods	1607	# default implementations for many methods
1402		1608
1403	sub time {	1609	sub time {
1404	eval q{ # poor man's autoloading {}	1610	eval q{ # poor man's autoloading {}
1405	# probe for availability of Time::HiRes	1611	# probe for availability of Time::HiRes
1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1612	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1613	*time = sub { Time::HiRes::time () };
1408	*AE::time = \&Time::HiRes::time;	1614	*AE::time = \& Time::HiRes::time ;
		1615	*now = \&time;
		1616	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1409	# if (eval "use POSIX (); (POSIX::times())...	1617	# if (eval "use POSIX (); (POSIX::times())...
1410	} else {	1618	} else {
		1619	*time = sub { CORE::time };
		1620	*AE::time = sub (){ CORE::time };
		1621	*now = \&time;
1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1622	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1412	*AE::time = sub (){ time }; # epic fail
1413	}	1623	}
1414
1415	*time = sub { AE::time }; # different prototypes
1416	};	1624	};
1417	die if $@;	1625	die if $@;
1418		1626
1419	&time	1627	&time
1420	}	1628	}
1421		1629
1422	*now = \&time;	1630	*now = \&time;
1423
1424	sub now_update { }	1631	sub now_update { }
1425		1632
		1633	sub _poll {
		1634	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1635	}
		1636
1426	# default implementation for ->condvar	1637	# default implementation for ->condvar
		1638	# in fact, the default should not be overwritten
1427		1639
1428	sub condvar {	1640	sub condvar {
1429	eval q{ # poor man's autoloading {}	1641	eval q{ # poor man's autoloading {}
1430	*condvar = sub {	1642	*condvar = sub {
1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1643	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1509		1721
1510	sub signal {	1722	sub signal {
1511	eval q{ # poor man's autoloading {}	1723	eval q{ # poor man's autoloading {}
1512	# probe for availability of Async::Interrupt	1724	# probe for availability of Async::Interrupt
1513	if (_have_async_interrupt) {	1725	if (_have_async_interrupt) {
1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1726	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1515		1727
1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1728	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1729	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1518		1730
1519	} else {	1731	} else {
1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1732	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1521		1733
1522	if (AnyEvent::WIN32) {	1734	if (AnyEvent::WIN32) {
1523	require AnyEvent::Util;	1735	require AnyEvent::Util;
1524		1736
1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1737	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1601	: sysread $SIGPIPE_R, (my $dummy), 9;	1813	: sysread $SIGPIPE_R, (my $dummy), 9;
1602		1814
1603	while (%SIG_EV) {	1815	while (%SIG_EV) {
1604	for (keys %SIG_EV) {	1816	for (keys %SIG_EV) {
1605	delete $SIG_EV{$_};	1817	delete $SIG_EV{$_};
1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1818	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1607	}	1819	}
1608	}	1820	}
1609	};	1821	};
1610	};	1822	};
1611	die if $@;	1823	die if $@;
…		…
1638	};	1850	};
1639		1851
1640	*child = sub {	1852	*child = sub {
1641	my (undef, %arg) = @_;	1853	my (undef, %arg) = @_;
1642		1854
1643	defined (my $pid = $arg{pid} + 0)	1855	my $pid = $arg{pid};
1644	or Carp::croak "required option 'pid' is missing";	1856	my $cb = $arg{cb};
1645		1857
1646	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1858	$PID_CB{$pid}{$cb+0} = $cb;
1647		1859
1648	unless ($CHLD_W) {	1860	unless ($CHLD_W) {
1649	$CHLD_W = AE::signal CHLD => \&_sigchld;	1861	$CHLD_W = AE::signal CHLD => \&_sigchld;
1650	# child could be a zombie already, so make at least one round	1862	# child could be a zombie already, so make at least one round
1651	&_sigchld;	1863	&_sigchld;
1652	}	1864	}
1653		1865
1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1866	bless [$pid, $cb+0], "AnyEvent::Base::child"
1655	};	1867	};
1656		1868
1657	*AnyEvent::Base::child::DESTROY = sub {	1869	*AnyEvent::Base::child::DESTROY = sub {
1658	my ($pid, $cb) = @{$_[0]};	1870	my ($pid, $icb) = @{$_[0]};
1659		1871
1660	delete $PID_CB{$pid}{$cb};	1872	delete $PID_CB{$pid}{$icb};
1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1873	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662		1874
1663	undef $CHLD_W unless keys %PID_CB;	1875	undef $CHLD_W unless keys %PID_CB;
1664	};	1876	};
1665	};	1877	};
…		…
1678		1890
1679	my ($cb, $w, $rcb) = $arg{cb};	1891	my ($cb, $w, $rcb) = $arg{cb};
1680		1892
1681	$rcb = sub {	1893	$rcb = sub {
1682	if ($cb) {	1894	if ($cb) {
1683	$w = _time;	1895	$w = AE::time;
1684	&$cb;	1896	&$cb;
1685	$w = _time - $w;	1897	$w = AE::time - $w;
1686		1898
1687	# never use more then 50% of the time for the idle watcher,	1899	# never use more then 50% of the time for the idle watcher,
1688	# within some limits	1900	# within some limits
1689	$w = 0.0001 if $w < 0.0001;	1901	$w = 0.0001 if $w < 0.0001;
1690	$w = 5 if $w > 5;	1902	$w = 5 if $w > 5;
…		…
1737		1949
1738	sub _send {	1950	sub _send {
1739	# nop	1951	# nop
1740	}	1952	}
1741		1953
		1954	sub _wait {
		1955	AnyEvent->_poll until $_[0]{_ae_sent};
		1956	}
		1957
1742	sub send {	1958	sub send {
1743	my $cv = shift;	1959	my $cv = shift;
1744	$cv->{_ae_sent} = [@_];	1960	$cv->{_ae_sent} = [@_];
1745	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1961	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746	$cv->_send;	1962	$cv->_send;
…		…
1753		1969
1754	sub ready {	1970	sub ready {
1755	$_[0]{_ae_sent}	1971	$_[0]{_ae_sent}
1756	}	1972	}
1757		1973
1758	sub _wait {
1759	$WAITING
1760	and !$_[0]{_ae_sent}
1761	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1762
1763	local $WAITING = 1;
1764	AnyEvent->one_event while !$_[0]{_ae_sent};
1765	}
1766
1767	sub recv {	1974	sub recv {
		1975	unless ($_[0]{_ae_sent}) {
		1976	$WAITING
		1977	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1978
		1979	local $WAITING = 1;
1768	$_[0]->_wait;	1980	$_[0]->_wait;
		1981	}
1769		1982
1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1983	$_[0]{_ae_croak}
1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1984	and Carp::croak $_[0]{_ae_croak};
		1985
		1986	wantarray
		1987	? @{ $_[0]{_ae_sent} }
		1988	: $_[0]{_ae_sent}[0]
1772	}	1989	}
1773		1990
1774	sub cb {	1991	sub cb {
1775	my $cv = shift;	1992	my $cv = shift;
1776		1993
…		…
1792	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	2009	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1793	}	2010	}
1794		2011
1795	# undocumented/compatibility with pre-3.4	2012	# undocumented/compatibility with pre-3.4
1796	*broadcast = \&send;	2013	*broadcast = \&send;
1797	*wait = \&_wait;	2014	*wait = \&recv;
1798		2015
1799	=head1 ERROR AND EXCEPTION HANDLING	2016	=head1 ERROR AND EXCEPTION HANDLING
1800		2017
1801	In general, AnyEvent does not do any error handling - it relies on the	2018	In general, AnyEvent does not do any error handling - it relies on the
1802	caller to do that if required. The L<AnyEvent::Strict> module (see also	2019	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1814	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2031	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1815	so on.	2032	so on.
1816		2033
1817	=head1 ENVIRONMENT VARIABLES	2034	=head1 ENVIRONMENT VARIABLES
1818		2035
1819	The following environment variables are used by this module or its	2036	AnyEvent supports a number of environment variables that tune the
1820	submodules.	2037	runtime behaviour. They are usually evaluated when AnyEvent is
		2038	loaded, initialised, or a submodule that uses them is loaded. Many of
		2039	them also cause AnyEvent to load additional modules - for example,
		2040	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2041	loaded.
1821		2042
1822	Note that AnyEvent will remove I<all> environment variables starting with	2043	All the environment variables documented here start with
1823	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2044	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1824	enabled.	2045	namespace. Other modules are encouraged (but by no means required) to use
		2046	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2047	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2048	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2049	variables starting with C<AE_>, see below).
		2050
		2051	All variables can also be set via the C<AE_> prefix, that is, instead
		2052	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2053	case there is a clash btween anyevent and another program that uses
		2054	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2055	variable to the empty string, as those variables take precedence.
		2056
		2057	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2058	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2059	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2060	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2061	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2062	is set).
		2063
		2064	The exact algorithm is currently:
		2065
		2066	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2067	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2068	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2069
		2070	This ensures that child processes will not see the C<AE_> variables.
		2071
		2072	The following environment variables are currently known to AnyEvent:
1825		2073
1826	=over 4	2074	=over 4
1827		2075
1828	=item C<PERL_ANYEVENT_VERBOSE>	2076	=item C<PERL_ANYEVENT_VERBOSE>
1829		2077
1830	By default, AnyEvent will be completely silent except in fatal	2078	By default, AnyEvent will only log messages with loglevel C<3>
1831	conditions. You can set this environment variable to make AnyEvent more	2079	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2080	environment variable to a numerical loglevel to make AnyEvent more (or
1832	talkative.	2081	less) talkative.
1833		2082
		2083	If you want to do more than just set the global logging level
		2084	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2085	complex specifications.
		2086
		2087	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2088	the default logging settings.
		2089
1834	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2090	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1835	conditions, such as not being able to load the event model specified by	2091	unexpected conditions, such as not being able to load the event model
1836	C<PERL_ANYEVENT_MODEL>.	2092	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2093	exception - this is the minimum recommended level.
1837		2094
1838	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2095	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1839	model it chooses.	2096	chooses.
1840		2097
1841	When set to C<8> or higher, then AnyEvent will report extra information on	2098	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1842	which optional modules it loads and how it implements certain features.	2099	which optional modules it loads and how it implements certain features.
		2100
		2101	=item C<PERL_ANYEVENT_LOG>
		2102
		2103	Accepts rather complex logging specifications. For example, you could log
		2104	all C<debug> messages of some module to stderr, warnings and above to
		2105	stderr, and errors and above to syslog, with:
		2106
		2107	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2108
		2109	For the rather extensive details, see L<AnyEvent::Log>.
		2110
		2111	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2112	so will take effect even before AnyEvent has initialised itself.
		2113
		2114	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2115	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2116	using the latter saves a few hundred kB of memory until the first message
		2117	is being logged.
1843		2118
1844	=item C<PERL_ANYEVENT_STRICT>	2119	=item C<PERL_ANYEVENT_STRICT>
1845		2120
1846	AnyEvent does not do much argument checking by default, as thorough	2121	AnyEvent does not do much argument checking by default, as thorough
1847	argument checking is very costly. Setting this variable to a true value	2122	argument checking is very costly. Setting this variable to a true value
…		…
1854	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2129	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1855	>>, it is definitely recommended to keep it off in production. Keeping	2130	>>, it is definitely recommended to keep it off in production. Keeping
1856	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2131	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857	can be very useful, however.	2132	can be very useful, however.
1858		2133
		2134	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2135
		2136	If this env variable is nonempty, then its contents will be interpreted by
		2137	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2138	replacing every occurance of C<$$> by the process pid). The shell object
		2139	is saved in C<$AnyEvent::Debug::SHELL>.
		2140
		2141	This happens when the first watcher is created.
		2142
		2143	For example, to bind a debug shell on a unix domain socket in
		2144	F<< /tmp/debug<pid>.sock >>, you could use this:
		2145
		2146	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2147	# connect with e.g.: socat readline /tmp/debug123.sock
		2148
		2149	Or to bind to tcp port 4545 on localhost:
		2150
		2151	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2152	# connect with e.g.: telnet localhost 4545
		2153
		2154	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2155	multiuser systems.
		2156
		2157	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2158
		2159	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2160	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2161
1859	=item C<PERL_ANYEVENT_MODEL>	2162	=item C<PERL_ANYEVENT_MODEL>
1860		2163
1861	This can be used to specify the event model to be used by AnyEvent, before	2164	This can be used to specify the event model to be used by AnyEvent, before
1862	auto detection and -probing kicks in. It must be a string consisting	2165	auto detection and -probing kicks in.
1863	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2166
		2167	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2168	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1864	and the resulting module name is loaded and if the load was successful,	2169	resulting module name is loaded and - if the load was successful - used as
1865	used as event model. If it fails to load AnyEvent will proceed with	2170	event model backend. If it fails to load then AnyEvent will proceed with
1866	auto detection and -probing.	2171	auto detection and -probing.
1867		2172
1868	This functionality might change in future versions.	2173	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2174	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2175	the end of a string designates a module name and quotes it appropriately).
1869		2176
1870	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2177	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871	could start your program like this:	2178	could start your program like this:
1872		2179
1873	PERL_ANYEVENT_MODEL=Perl perl ...	2180	PERL_ANYEVENT_MODEL=Perl perl ...
1874		2181
1875	=item C<PERL_ANYEVENT_PROTOCOLS>	2182	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1891	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2198	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1892	- only support IPv4, never try to resolve or contact IPv6	2199	- only support IPv4, never try to resolve or contact IPv6
1893	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2200	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1894	IPv6, but prefer IPv6 over IPv4.	2201	IPv6, but prefer IPv6 over IPv4.
1895		2202
		2203	=item C<PERL_ANYEVENT_HOSTS>
		2204
		2205	This variable, if specified, overrides the F</etc/hosts> file used by
		2206	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2207	from that file instead.
		2208
1896	=item C<PERL_ANYEVENT_EDNS0>	2209	=item C<PERL_ANYEVENT_EDNS0>
1897		2210
1898	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2211	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1899	for DNS. This extension is generally useful to reduce DNS traffic, but	2212	DNS. This extension is generally useful to reduce DNS traffic, especially
1900	some (broken) firewalls drop such DNS packets, which is why it is off by	2213	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1901	default.	2214	packets, which is why it is off by default.
1902		2215
1903	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2216	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1904	EDNS0 in its DNS requests.	2217	EDNS0 in its DNS requests.
1905		2218
1906	=item C<PERL_ANYEVENT_MAX_FORKS>	2219	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1912		2225
1913	The default value for the C<max_outstanding> parameter for the default DNS	2226	The default value for the C<max_outstanding> parameter for the default DNS
1914	resolver - this is the maximum number of parallel DNS requests that are	2227	resolver - this is the maximum number of parallel DNS requests that are
1915	sent to the DNS server.	2228	sent to the DNS server.
1916		2229
		2230	=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
		2231
		2232	Perl has inherently racy signal handling (you can basically choose between
		2233	losing signals and memory corruption) - pure perl event loops (including
		2234	C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
		2235	have to poll regularly to avoid losing signals.
		2236
		2237	Some event loops are racy, but don't poll regularly, and some event loops
		2238	are written in C but are still racy. For those event loops, AnyEvent
		2239	installs a timer that regularly wakes up the event loop.
		2240
		2241	By default, the interval for this timer is C<10> seconds, but you can
		2242	override this delay with this environment variable (or by setting
		2243	the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
		2244	watchers).
		2245
		2246	Lower values increase CPU (and energy) usage, higher values can introduce
		2247	long delays when reaping children or waiting for signals.
		2248
		2249	The L<AnyEvent::Async> module, if available, will be used to avoid this
		2250	polling (with most event loops).
		2251
1917	=item C<PERL_ANYEVENT_RESOLV_CONF>	2252	=item C<PERL_ANYEVENT_RESOLV_CONF>
1918		2253
1919	The file to use instead of F</etc/resolv.conf> (or OS-specific	2254	The absolute path to a F<resolv.conf>-style file to use instead of
1920	configuration) in the default resolver. When set to the empty string, no	2255	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1921	default config will be used.	2256	resolver, or the empty string to select the default configuration.
1922		2257
1923	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2258	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1924		2259
1925	When neither C<ca_file> nor C<ca_path> was specified during	2260	When neither C<ca_file> nor C<ca_path> was specified during
1926	L<AnyEvent::TLS> context creation, and either of these environment	2261	L<AnyEvent::TLS> context creation, and either of these environment
1927	variables exist, they will be used to specify CA certificate locations	2262	variables are nonempty, they will be used to specify CA certificate
1928	instead of a system-dependent default.	2263	locations instead of a system-dependent default.
1929		2264
1930	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2265	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1931		2266
1932	When these are set to C<1>, then the respective modules are not	2267	When these are set to C<1>, then the respective modules are not
1933	loaded. Mostly good for testing AnyEvent itself.	2268	loaded. Mostly good for testing AnyEvent itself.
…		…
2265	(even when used without AnyEvent), but most event loops have acceptable	2600	(even when used without AnyEvent), but most event loops have acceptable
2266	performance with or without AnyEvent.	2601	performance with or without AnyEvent.
2267		2602
2268	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2603	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2269	the actual event loop, only with extremely fast event loops such as EV	2604	the actual event loop, only with extremely fast event loops such as EV
2270	adds AnyEvent significant overhead.	2605	does AnyEvent add significant overhead.
2271		2606
2272	=item * You should avoid POE like the plague if you want performance or	2607	=item * You should avoid POE like the plague if you want performance or
2273	reasonable memory usage.	2608	reasonable memory usage.
2274		2609
2275	=back	2610	=back
…		…
2574		2909
2575	=item L<Time::HiRes>	2910	=item L<Time::HiRes>
2576		2911
2577	This module is part of perl since release 5.008. It will be used when the	2912	This module is part of perl since release 5.008. It will be used when the
2578	chosen event library does not come with a timing source of its own. The	2913	chosen event library does not come with a timing source of its own. The
2579	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2914	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580	try to use a monotonic clock for timing stability.	2915	try to use a monotonic clock for timing stability.
2581		2916
2582	=back	2917	=back
2583		2918
2584		2919
…		…
2650		2985
2651	Tutorial/Introduction: L<AnyEvent::Intro>.	2986	Tutorial/Introduction: L<AnyEvent::Intro>.
2652		2987
2653	FAQ: L<AnyEvent::FAQ>.	2988	FAQ: L<AnyEvent::FAQ>.
2654		2989
2655	Utility functions: L<AnyEvent::Util>.	2990	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2991	(simply logging).
2656		2992
2657	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2993	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2994	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2995
		2996	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2997	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2998	L<Qt>, L<POE>, L<FLTK>.
2659		2999
2660	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	3000	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	3001	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	3002	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	3003	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		3004	L<AnyEvent::Impl::FLTK>.
2664		3005
2665	Non-blocking file handles, sockets, TCP clients and	3006	Non-blocking handles, pipes, stream sockets, TCP clients and
2666	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	3007	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667		3008
2668	Asynchronous DNS: L<AnyEvent::DNS>.	3009	Asynchronous DNS: L<AnyEvent::DNS>.
2669		3010
2670	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	3011	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.348 by root, Thu Feb 24 12:04:20 2011 UTC vs. Revision 1.396 by root, Sat Mar 10 17:36:24 2012 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.348 by root, Thu Feb 24 12:04:20 2011 UTC vs.
Revision 1.396 by root, Sat Mar 10 17:36:24 2012 UTC