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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.331 by root, Tue Aug 31 01:00:48 2010 UTC vs.
Revision 1.410 by root, Fri Mar 1 06:03:21 2013 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
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
…		…
413	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's	415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
414	pure perl implementation).	416	pure perl implementation).
415		417
416	=head3 Safe/Unsafe Signals	418	=head3 Safe/Unsafe Signals
417		419
418	Perl signals can be either "safe" (synchronous to opcode handling) or	420	Perl signals can be either "safe" (synchronous to opcode handling)
419	"unsafe" (asynchronous) - the former might get delayed indefinitely, the	421	or "unsafe" (asynchronous) - the former might delay signal delivery
420	latter might corrupt your memory.	422	indefinitely, the latter might corrupt your memory.
421		423
422	AnyEvent signal handlers are, in addition, synchronous to the event loop,	424	AnyEvent signal handlers are, in addition, synchronous to the event loop,
423	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
424	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.
425	callbacks, too).	427	callbacks, too).
426		428
427	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
428		430
429	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
430	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,
431	do race-free signal handling in perl, requiring C libraries for	433	as you cannot do race-free signal handling in perl, requiring
432	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
433	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
434	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	436	a signal might be delayed is 10 seconds by default, but can
435	variable can be changed only before the first signal watcher is created,	437	be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
436	and should be left alone otherwise. This variable determines how often	438	C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
437	AnyEvent polls for signals (in case a wake-up was missed). Higher values	439	section for details.
438	will cause fewer spurious wake-ups, which is better for power and CPU
439	saving.
440		440
441	All these problems can be avoided by installing the optional	441	All these problems can be avoided by installing the optional
442	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
443	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>
444	(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
445	one-second latency). For those, you just have to suffer the delays.	445	delays.
446		446
447	=head2 CHILD PROCESS WATCHERS	447	=head2 CHILD PROCESS WATCHERS
448		448
449	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	449	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
450		450
…		…
480	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
481	watcher before you C<fork> the child (alternatively, you can call	481	watcher before you C<fork> the child (alternatively, you can call
482	C<AnyEvent::detect>).	482	C<AnyEvent::detect>).
483		483
484	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
485	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
486	mentioned in the description of signal watchers apply.	486	problems mentioned in the description of signal watchers apply.
487		487
488	Example: fork a process and wait for it	488	Example: fork a process and wait for it
489		489
490	my $done = AnyEvent->condvar;	490	my $done = AnyEvent->condvar;
491		491
…		…
763	};	763	};
764	}	764	}
765		765
766	$cv->end;	766	$cv->end;
767		767
		768	...
		769
		770	my $results = $cv->recv;
		771
768	This code fragment supposedly pings a number of hosts and calls	772	This code fragment supposedly pings a number of hosts and calls
769	C<send> after results for all then have have been gathered - in any	773	C<send> after results for all then have have been gathered - in any
770	order. To achieve this, the code issues a call to C<begin> when it starts	774	order. To achieve this, the code issues a call to C<begin> when it starts
771	each ping request and calls C<end> when it has received some result for	775	each ping request and calls C<end> when it has received some result for
772	it. Since C<begin> and C<end> only maintain a counter, the order in which	776	it. Since C<begin> and C<end> only maintain a counter, the order in which
…		…
807		811
808	In list context, all parameters passed to C<send> will be returned,	812	In list context, all parameters passed to C<send> will be returned,
809	in scalar context only the first one will be returned.	813	in scalar context only the first one will be returned.
810		814
811	Note that doing a blocking wait in a callback is not supported by any	815	Note that doing a blocking wait in a callback is not supported by any
812	event loop, that is, recursive invocation of a blocking C<< ->recv	816	event loop, that is, recursive invocation of a blocking C<< ->recv >> is
813	>> is not allowed, and the C<recv> call will C<croak> if such a	817	not allowed and the C<recv> call will C<croak> if such a condition is
814	condition is detected. This condition can be slightly loosened by using	818	detected. This requirement can be dropped by relying on L<Coro::AnyEvent>
815	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from	819	, which allows you to do a blocking C<< ->recv >> from any thread
816	any thread that doesn't run the event loop itself.	820	that doesn't run the event loop itself. L<Coro::AnyEvent> is loaded
		821	automatically when L<Coro> is used with L<AnyEvent>, so code does not need
		822	to do anything special to take advantage of that: any code that would
		823	normally block your program because it calls C<recv>, be executed in an
		824	C<async> thread instead without blocking other threads.
817		825
818	Not all event models support a blocking wait - some die in that case	826	Not all event models support a blocking wait - some die in that case
819	(programs might want to do that to stay interactive), so I<if you are	827	(programs might want to do that to stay interactive), so I<if you are
820	using this from a module, never require a blocking wait>. Instead, let the	828	using this from a module, never require a blocking wait>. Instead, let the
821	caller decide whether the call will block or not (for example, by coupling	829	caller decide whether the call will block or not (for example, by coupling
…		…
858	use. If EV is not installed, then AnyEvent will fall back to its own	866	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	867	pure-perl implementation, which is available everywhere as it comes with
860	AnyEvent itself.	868	AnyEvent itself.
861		869
862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	870	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
863	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	871	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
864		872
865	=item Backends that are transparently being picked up when they are used.	873	=item Backends that are transparently being picked up when they are used.
866		874
867	These will be used if they are already loaded when the first watcher	875	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	876	is created, in which case it is assumed that the application is using
…		…
874	AnyEvent::Impl::Glib based on Glib, slow but very stable.	882	AnyEvent::Impl::Glib based on Glib, slow but very stable.
875	AnyEvent::Impl::Tk based on Tk, very broken.	883	AnyEvent::Impl::Tk based on Tk, very broken.
876	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	884	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
877	AnyEvent::Impl::POE based on POE, very slow, some limitations.	885	AnyEvent::Impl::POE based on POE, very slow, some limitations.
878	AnyEvent::Impl::Irssi used when running within irssi.	886	AnyEvent::Impl::Irssi used when running within irssi.
		887	AnyEvent::Impl::IOAsync based on IO::Async.
		888	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		889	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
879		890
880	=item Backends with special needs.	891	=item Backends with special needs.
881		892
882	Qt requires the Qt::Application to be instantiated first, but will	893	Qt requires the Qt::Application to be instantiated first, but will
883	otherwise be picked up automatically. As long as the main program	894	otherwise be picked up automatically. As long as the main program
884	instantiates the application before any AnyEvent watchers are created,	895	instantiates the application before any AnyEvent watchers are created,
885	everything should just work.	896	everything should just work.
886		897
887	AnyEvent::Impl::Qt based on Qt.	898	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		899
897	=item Event loops that are indirectly supported via other backends.	900	=item Event loops that are indirectly supported via other backends.
898		901
899	Some event loops can be supported via other modules:	902	Some event loops can be supported via other modules:
900		903
…		…
936		939
937	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	940	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
938	if necessary. You should only call this function right before you would	941	if necessary. You should only call this function right before you would
939	have created an AnyEvent watcher anyway, that is, as late as possible at	942	have created an AnyEvent watcher anyway, that is, as late as possible at
940	runtime, and not e.g. during initialisation of your module.	943	runtime, and not e.g. during initialisation of your module.
		944
		945	The effect of calling this function is as if a watcher had been created
		946	(specifically, actions that happen "when the first watcher is created"
		947	happen when calling detetc as well).
941		948
942	If you need to do some initialisation before AnyEvent watchers are	949	If you need to do some initialisation before AnyEvent watchers are
943	created, use C<post_detect>.	950	created, use C<post_detect>.
944		951
945	=item $guard = AnyEvent::post_detect { BLOCK }	952	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1008	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1015	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009	# as soon as it is	1016	# as soon as it is
1010	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1017	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011	}	1018	}
1012		1019
		1020	=item AnyEvent::postpone { BLOCK }
		1021
		1022	Arranges for the block to be executed as soon as possible, but not before
		1023	the call itself returns. In practise, the block will be executed just
		1024	before the event loop polls for new events, or shortly afterwards.
		1025
		1026	This function never returns anything (to make the C<return postpone { ...
		1027	}> idiom more useful.
		1028
		1029	To understand the usefulness of this function, consider a function that
		1030	asynchronously does something for you and returns some transaction
		1031	object or guard to let you cancel the operation. For example,
		1032	C<AnyEvent::Socket::tcp_connect>:
		1033
		1034	# start a conenction attempt unless one is active
		1035	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1036	delete $self->{connect_guard};
		1037	...
		1038	};
		1039
		1040	Imagine that this function could instantly call the callback, for
		1041	example, because it detects an obvious error such as a negative port
		1042	number. Invoking the callback before the function returns causes problems
		1043	however: the callback will be called and will try to delete the guard
		1044	object. But since the function hasn't returned yet, there is nothing to
		1045	delete. When the function eventually returns it will assign the guard
		1046	object to C<< $self->{connect_guard} >>, where it will likely never be
		1047	deleted, so the program thinks it is still trying to connect.
		1048
		1049	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1050	callback directly on error:
		1051
		1052	$cb->(undef), return # signal error to callback, BAD!
		1053	if $some_error_condition;
		1054
		1055	It should use C<postpone>:
		1056
		1057	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1058	if $some_error_condition;
		1059
		1060	=item AnyEvent::log $level, $msg[, @args]
		1061
		1062	Log the given C<$msg> at the given C<$level>.
		1063
		1064	If L<AnyEvent::Log> is not loaded then this function makes a simple test
		1065	to see whether the message will be logged. If the test succeeds it will
		1066	load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
		1067	the L<AnyEvent::Log> documentation for details.
		1068
		1069	If the test fails it will simply return. Right now this happens when a
		1070	numerical loglevel is used and it is larger than the level specified via
		1071	C<$ENV{PERL_ANYEVENT_VERBOSE}>.
		1072
		1073	If you want to sprinkle loads of logging calls around your code, consider
		1074	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1075	which can reduce typing, codesize and can reduce the logging overhead
		1076	enourmously.
		1077
1013	=back	1078	=back
1014		1079
1015	=head1 WHAT TO DO IN A MODULE	1080	=head1 WHAT TO DO IN A MODULE
1016		1081
1017	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1082	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	1115	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	1116	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.	1117	might choose the wrong one unless you load the correct one yourself.
1053		1118
1054	You can chose to use a pure-perl implementation by loading the	1119	You can chose to use a pure-perl implementation by loading the
1055	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1120	C<AnyEvent::Loop> module, which gives you similar behaviour
1056	everywhere, but letting AnyEvent chose the model is generally better.	1121	everywhere, but letting AnyEvent chose the model is generally better.
1057		1122
1058	=head2 MAINLOOP EMULATION	1123	=head2 MAINLOOP EMULATION
1059		1124
1060	Sometimes (often for short test scripts, or even standalone programs who	1125	Sometimes (often for short test scripts, or even standalone programs who
…		…
1073		1138
1074		1139
1075	=head1 OTHER MODULES	1140	=head1 OTHER MODULES
1076		1141
1077	The following is a non-exhaustive list of additional modules that use	1142	The following is a non-exhaustive list of additional modules that use
1078	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1143	AnyEvent as a client and can therefore be mixed easily with other
1079	modules and other event loops in the same program. Some of the modules	1144	AnyEvent modules and other event loops in the same program. Some of the
1080	come as part of AnyEvent, the others are available via CPAN.	1145	modules come as part of AnyEvent, the others are available via CPAN (see
		1146	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1147	a longer non-exhaustive list), and the list is heavily biased towards
		1148	modules of the AnyEvent author himself :)
1081		1149
1082	=over 4	1150	=over 4
1083		1151
1084	=item L<AnyEvent::Util>	1152	=item L<AnyEvent::Util>
1085		1153
…		…
1105	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>	1173	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1106		1174
1107	Implement event-based interfaces to the protocols of the same name (for	1175	Implement event-based interfaces to the protocols of the same name (for
1108	the curious, IGS is the International Go Server and FCP is the Freenet	1176	the curious, IGS is the International Go Server and FCP is the Freenet
1109	Client Protocol).	1177	Client Protocol).
1110
1111	=item L<AnyEvent::Handle::UDP>
1112
1113	Here be danger!
1114
1115	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1116	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1117	its use of a stream-based API with a protocol that isn't streamable, that
1118	the only way to improve it is to delete it.
1119
1120	It features data corruption (but typically only under load) and general
1121	confusion. On top, the author is not only clueless about UDP but also
1122	fact-resistant - some gems of his understanding: "connect doesn't work
1123	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1124	packets", "I don't need to implement proper error checking as UDP doesn't
1125	support error checking" and so on - he doesn't even understand what's
1126	wrong with his module when it is explained to him.
1127
1128	=item L<AnyEvent::DBI>
1129
1130	Executes L<DBI> requests asynchronously in a proxy process for you,
1131	notifying you in an event-based way when the operation is finished.
1132		1178
1133	=item L<AnyEvent::AIO>	1179	=item L<AnyEvent::AIO>
1134		1180
1135	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1181	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1136	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1182	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1137	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based	1183	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1138	file I/O, and much more.	1184	file I/O, and much more.
1139		1185
		1186	=item L<AnyEvent::Filesys::Notify>
		1187
		1188	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1189	path changes (e.g. "watch this directory for new files", "watch this
		1190	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1191	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1192	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1193	fall back to blocking scans at regular intervals transparently on other
		1194	platforms, so it's about as portable as it gets.
		1195
		1196	(I haven't used it myself, but I haven't heard anybody complaining about
		1197	it yet).
		1198
		1199	=item L<AnyEvent::DBI>
		1200
		1201	Executes L<DBI> requests asynchronously in a proxy process for you,
		1202	notifying you in an event-based way when the operation is finished.
		1203
1140	=item L<AnyEvent::HTTPD>	1204	=item L<AnyEvent::HTTPD>
1141		1205
1142	A simple embedded webserver.	1206	A simple embedded webserver.
1143		1207
1144	=item L<AnyEvent::FastPing>	1208	=item L<AnyEvent::FastPing>
1145		1209
1146	The fastest ping in the west.	1210	The fastest ping in the west.
1147		1211
1148	=item L<Coro>	1212	=item L<Coro>
1149		1213
1150	Has special support for AnyEvent via L<Coro::AnyEvent>.	1214	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1215	to simply invert the flow control - don't call us, we will call you:
		1216
		1217	async {
		1218	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1219	print "5 seconds later!\n";
		1220
		1221	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1222	my $line = <STDIN>; # works for ttys
		1223
		1224	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1225	my ($body, $hdr) = Coro::rouse_wait;
		1226	};
1151		1227
1152	=back	1228	=back
1153		1229
1154	=cut	1230	=cut
1155		1231
1156	package AnyEvent;	1232	package AnyEvent;
1157		1233
1158	# basically a tuned-down version of common::sense	1234	# basically a tuned-down version of common::sense
1159	sub common_sense {	1235	sub common_sense {
1160	# from common:.sense 1.0	1236	# from common:.sense 3.5
		1237	local $^W;
1161	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1238	${^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)	1239	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1163	$^H \|= 0x00000600;	1240	$^H \|= 0x00000600;
1164	}	1241	}
1165		1242
1166	BEGIN { AnyEvent::common_sense }	1243	BEGIN { AnyEvent::common_sense }
1167		1244
1168	use Carp ();	1245	use Carp ();
1169		1246
1170	our $VERSION = '5.271';	1247	our $VERSION = '7.04';
1171	our $MODEL;	1248	our $MODEL;
1172
1173	our $AUTOLOAD;
1174	our @ISA;	1249	our @ISA;
1175
1176	our @REGISTRY;	1250	our @REGISTRY;
1177
1178	our $VERBOSE;	1251	our $VERBOSE;
		1252	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
		1253	our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} \|\| 10; # executes after the BEGIN block below (tainting!)
1179		1254
1180	BEGIN {	1255	BEGIN {
1181	require "AnyEvent/constants.pl";	1256	require "AnyEvent/constants.pl";
1182		1257
1183	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1258	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1184		1259
1185	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1260	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1186	if ${^TAINT};	1261	if ${^TAINT};
1187		1262
1188	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1263	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1264	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1189		1265
1190	}	1266	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1267	if ${^TAINT};
1191		1268
1192	our $MAX_SIGNAL_LATENCY = 10;	1269	# $ENV{PERL_ANYEVENT_xxx} now valid
1193		1270
1194	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1271	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1195		1272
1196	{
1197	my $idx;	1273	my $idx;
1198	$PROTOCOL{$_} = ++$idx	1274	$PROTOCOL{$_} = ++$idx
1199	for reverse split /\s,\s/,	1275	for reverse split /\s,\s/,
1200	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1276	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1201	}	1277	}
1202		1278
		1279	our @post_detect;
		1280
		1281	sub post_detect(&) {
		1282	my ($cb) = @_;
		1283
		1284	push @post_detect, $cb;
		1285
		1286	defined wantarray
		1287	? bless \$cb, "AnyEvent::Util::postdetect"
		1288	: ()
		1289	}
		1290
		1291	sub AnyEvent::Util::postdetect::DESTROY {
		1292	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1293	}
		1294
		1295	our $POSTPONE_W;
		1296	our @POSTPONE;
		1297
		1298	sub _postpone_exec {
		1299	undef $POSTPONE_W;
		1300
		1301	&{ shift @POSTPONE }
		1302	while @POSTPONE;
		1303	}
		1304
		1305	sub postpone(&) {
		1306	push @POSTPONE, shift;
		1307
		1308	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1309
		1310	()
		1311	}
		1312
		1313	sub log($$;@) {
		1314	# only load the big bloated module when we actually are about to log something
		1315	if ($_[0] <= ($VERBOSE \|\| 1)) { # also catches non-numeric levels(!) and fatal
		1316	local ($!, $@);
		1317	require AnyEvent::Log; # among other things, sets $VERBOSE to 9
		1318	# AnyEvent::Log overwrites this function
		1319	goto &log;
		1320	}
		1321
		1322	0 # not logged
		1323	}
		1324
		1325	sub _logger($;$) {
		1326	my ($level, $renabled) = @_;
		1327
		1328	$$renabled = $level <= $VERBOSE;
		1329
		1330	my $logger = [(caller)[0], $level, $renabled];
		1331
		1332	$AnyEvent::Log::LOGGER{$logger+0} = $logger;
		1333
		1334	# return unless defined wantarray;
		1335	#
		1336	# require AnyEvent::Util;
		1337	# my $guard = AnyEvent::Util::guard (sub {
		1338	# # "clean up"
		1339	# delete $LOGGER{$logger+0};
		1340	# });
		1341	#
		1342	# sub {
		1343	# return 0 unless $$renabled;
		1344	#
		1345	# $guard if 0; # keep guard alive, but don't cause runtime overhead
		1346	# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
		1347	# package AnyEvent::Log;
		1348	# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
		1349	# }
		1350	}
		1351
		1352	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1353	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1354	}
		1355
1203	my @models = (	1356	our @models = (
1204	[EV:: => AnyEvent::Impl::EV:: , 1],	1357	[EV:: => AnyEvent::Impl::EV::],
1205	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1358	[AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1206	# everything below here will not (normally) be autoprobed	1359	# everything below here will not (normally) be autoprobed
1207	# as the pureperl backend should work everywhere	1360	# as the pure perl backend should work everywhere
1208	# and is usually faster	1361	# and is usually faster
		1362	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1209	[Event:: => AnyEvent::Impl::Event::, 1],	1363	[Event:: => AnyEvent::Impl::Event::], # slow, stable
1210	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1364	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		1365	# everything below here should not be autoloaded
1211	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1366	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1212	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1213	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1367	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1214	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1368	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1215	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1369	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1216	[Wx:: => AnyEvent::Impl::POE::],	1370	[Wx:: => AnyEvent::Impl::POE::],
1217	[Prima:: => AnyEvent::Impl::POE::],	1371	[Prima:: => AnyEvent::Impl::POE::],
1218	# IO::Async is just too broken - we would need workarounds for its	1372	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1219	# byzantine signal and broken child handling, among others.	1373	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1220	# IO::Async is rather hard to detect, as it doesn't have any	1374	[FLTK:: => AnyEvent::Impl::FLTK::],
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	);	1375	);
1227		1376
1228	our %method = map +($_ => 1),	1377	our @isa_hook;
		1378
		1379	sub _isa_set {
		1380	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1381
		1382	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1383	for 1 .. $#pkg;
		1384
		1385	grep $_ && $_->[1], @isa_hook
		1386	and AE::_reset ();
		1387	}
		1388
		1389	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1390	sub _isa_hook($$;$) {
		1391	my ($i, $pkg, $reset_ae) = @_;
		1392
		1393	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1394
		1395	_isa_set;
		1396	}
		1397
		1398	# all autoloaded methods reserve the complete glob, not just the method slot.
		1399	# due to bugs in perls method cache implementation.
1229	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1400	our @methods = qw(io timer time now now_update signal child idle condvar);
1230
1231	our @post_detect;
1232
1233	sub post_detect(&) {
1234	my ($cb) = @_;
1235
1236	push @post_detect, $cb;
1237
1238	defined wantarray
1239	? bless \$cb, "AnyEvent::Util::postdetect"
1240	: ()
1241	}
1242
1243	sub AnyEvent::Util::postdetect::DESTROY {
1244	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1245	}
1246		1401
1247	sub detect() {	1402	sub detect() {
		1403	return $MODEL if $MODEL; # some programs keep references to detect
		1404
		1405	# IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
		1406	# the author knows about the problems and what it does to AnyEvent as a whole
		1407	# (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
		1408	# anyway.
		1409	AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
		1410	. "design, abuses internals and breaks AnyEvent - will not continue."
		1411	if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
		1412
		1413	local $!; # for good measure
		1414	local $SIG{__DIE__}; # we use eval
		1415
1248	# free some memory	1416	# free some memory
1249	*detect = sub () { $MODEL };	1417	*detect = sub () { $MODEL };
		1418	# undef &func doesn't correctly update the method cache. grmbl.
		1419	# so we delete the whole glob. grmbl.
		1420	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1421	# a glob with an active sub. hrm. i hope it works, but perl is
		1422	# usually buggy in this department. sigh.
		1423	delete @{"AnyEvent::"}{@methods};
		1424	undef @methods;
1250		1425
1251	local $!; # for good measure
1252	local $SIG{__DIE__};
1253
1254	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1426	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1255	my $model = "AnyEvent::Impl::$1";	1427	my $model = $1;
		1428	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1256	if (eval "require $model") {	1429	if (eval "require $model") {
		1430	AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1257	$MODEL = $model;	1431	$MODEL = $model;
1258	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1259	} else {	1432	} else {
1260	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1433	AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1261	}	1434	}
1262	}	1435	}
1263		1436
1264	# check for already loaded models	1437	# check for already loaded models
1265	unless ($MODEL) {	1438	unless ($MODEL) {
1266	for (@REGISTRY, @models) {	1439	for (@REGISTRY, @models) {
1267	my ($package, $model) = @$_;	1440	my ($package, $model) = @$_;
1268	if (${"$package\::VERSION"} > 0) {	1441	if (${"$package\::VERSION"} > 0) {
1269	if (eval "require $model") {	1442	if (eval "require $model") {
		1443	AnyEvent::log 7 => "Autodetected model '$model', using it.";
1270	$MODEL = $model;	1444	$MODEL = $model;
1271	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1445	last;
		1446	} else {
		1447	AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
		1448	}
		1449	}
		1450	}
		1451
		1452	unless ($MODEL) {
		1453	# try to autoload a model
		1454	for (@REGISTRY, @models) {
		1455	my ($package, $model) = @$_;
		1456	if (
		1457	eval "require $package"
		1458	and ${"$package\::VERSION"} > 0
		1459	and eval "require $model"
		1460	) {
		1461	AnyEvent::log 7 => "Autoloaded model '$model', using it.";
		1462	$MODEL = $model;
1272	last;	1463	last;
1273	}	1464	}
1274	}	1465	}
1275	}
1276
1277	unless ($MODEL) {
1278	# try to autoload a model
1279	for (@REGISTRY, @models) {
1280	my ($package, $model, $autoload) = @$_;
1281	if (
1282	$autoload
1283	and eval "require $package"
1284	and ${"$package\::VERSION"} > 0
1285	and eval "require $model"
1286	) {
1287	$MODEL = $model;
1288	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1289	last;
1290	}
1291	}
1292		1466
1293	$MODEL	1467	$MODEL
1294	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1468	or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
1295	}	1469	}
1296	}	1470	}
1297		1471
1298	@models = (); # free probe data	1472	# free memory only needed for probing
		1473	undef @models;
		1474	undef @REGISTRY;
1299		1475
1300	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1476	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1301	unshift @ISA, $MODEL;
1302		1477
1303	# now nuke some methods that are overriden by the backend.	1478	# now nuke some methods that are overridden by the backend.
1304	# SUPER is not allowed.	1479	# SUPER usage is not allowed in these.
1305	for (qw(time signal child idle)) {	1480	for (qw(time signal child idle)) {
1306	undef &{"AnyEvent::Base::$_"}	1481	undef &{"AnyEvent::Base::$_"}
1307	if defined &{"$MODEL\::$_"};	1482	if defined &{"$MODEL\::$_"};
1308	}	1483	}
1309		1484
1310	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1485	_isa_set;
		1486
		1487	# we're officially open!
		1488
		1489	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1490	require AnyEvent::Strict;
		1491	}
		1492
		1493	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1494	require AnyEvent::Debug;
		1495	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1496	}
		1497
		1498	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1499	require AnyEvent::Socket;
		1500	require AnyEvent::Debug;
		1501
		1502	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1503	$shell =~ s/\$\$/$$/g;
		1504
		1505	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1506	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1507	}
		1508
		1509	# now the anyevent environment is set up as the user told us to, so
		1510	# call the actual user code - post detects
1311		1511
1312	(shift @post_detect)->() while @post_detect;	1512	(shift @post_detect)->() while @post_detect;
		1513	undef @post_detect;
1313		1514
1314	*post_detect = sub(&) {	1515	*post_detect = sub(&) {
1315	shift->();	1516	shift->();
1316		1517
1317	undef	1518	undef
1318	};	1519	};
1319		1520
1320	$MODEL	1521	$MODEL
1321	}	1522	}
1322		1523
1323	sub AUTOLOAD {	1524	for my $name (@methods) {
1324	(my $func = $AUTOLOAD) =~ s/.*://;	1525	*$name = sub {
1325
1326	$method{$func}
1327	or Carp::croak "$func: not a valid AnyEvent class method";
1328
1329	detect;	1526	detect;
1330		1527	# we use goto because
1331	my $class = shift;	1528	# a) it makes the thunk more transparent
1332	$class->$func (@_);	1529	# b) it allows us to delete the thunk later
		1530	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1531	};
1333	}	1532	}
1334		1533
1335	# utility function to dup a filehandle. this is used by many backends	1534	# utility function to dup a filehandle. this is used by many backends
1336	# to support binding more than one watcher per filehandle (they usually	1535	# to support binding more than one watcher per filehandle (they usually
1337	# allow only one watcher per fd, so we dup it to get a different one).	1536	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1361		1560
1362	package AE;	1561	package AE;
1363		1562
1364	our $VERSION = $AnyEvent::VERSION;	1563	our $VERSION = $AnyEvent::VERSION;
1365		1564
		1565	sub _reset() {
		1566	eval q{
1366	# fall back to the main API by default - backends and AnyEvent::Base	1567	# fall back to the main API by default - backends and AnyEvent::Base
1367	# implementations can overwrite these.	1568	# implementations can overwrite these.
1368		1569
1369	sub io($$$) {	1570	sub io($$$) {
1370	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1571	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1371	}	1572	}
1372		1573
1373	sub timer($$$) {	1574	sub timer($$$) {
1374	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1575	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1375	}	1576	}
1376		1577
1377	sub signal($$) {	1578	sub signal($$) {
1378	AnyEvent->signal (signal => $_[0], cb => $_[1])	1579	AnyEvent->signal (signal => $_[0], cb => $_[1])
1379	}	1580	}
1380		1581
1381	sub child($$) {	1582	sub child($$) {
1382	AnyEvent->child (pid => $_[0], cb => $_[1])	1583	AnyEvent->child (pid => $_[0], cb => $_[1])
1383	}	1584	}
1384		1585
1385	sub idle($) {	1586	sub idle($) {
1386	AnyEvent->idle (cb => $_[0])	1587	AnyEvent->idle (cb => $_[0]);
1387	}	1588	}
1388		1589
1389	sub cv(;&) {	1590	sub cv(;&) {
1390	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1591	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1391	}	1592	}
1392		1593
1393	sub now() {	1594	sub now() {
1394	AnyEvent->now	1595	AnyEvent->now
1395	}	1596	}
1396		1597
1397	sub now_update() {	1598	sub now_update() {
1398	AnyEvent->now_update	1599	AnyEvent->now_update
1399	}	1600	}
1400		1601
1401	sub time() {	1602	sub time() {
1402	AnyEvent->time	1603	AnyEvent->time
		1604	}
		1605
		1606	*postpone = \&AnyEvent::postpone;
		1607	*log = \&AnyEvent::log;
		1608	};
		1609	die if $@;
1403	}	1610	}
		1611
		1612	BEGIN { _reset }
1404		1613
1405	package AnyEvent::Base;	1614	package AnyEvent::Base;
1406		1615
1407	# default implementations for many methods	1616	# default implementations for many methods
1408		1617
1409	sub time {	1618	sub time {
1410	eval q{ # poor man's autoloading {}	1619	eval q{ # poor man's autoloading {}
1411	# probe for availability of Time::HiRes	1620	# probe for availability of Time::HiRes
1412	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1621	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1413	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1622	*time = sub { Time::HiRes::time () };
1414	*AE::time = \&Time::HiRes::time;	1623	*AE::time = \& Time::HiRes::time ;
		1624	*now = \&time;
		1625	AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1415	# if (eval "use POSIX (); (POSIX::times())...	1626	# if (eval "use POSIX (); (POSIX::times())...
1416	} else {	1627	} else {
1417	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1628	*time = sub { CORE::time };
1418	*AE::time = sub (){ time }; # epic fail	1629	*AE::time = sub (){ CORE::time };
		1630	*now = \&time;
		1631	AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
1419	}	1632	}
1420
1421	*time = sub { AE::time }; # different prototypes
1422	};	1633	};
1423	die if $@;	1634	die if $@;
1424		1635
1425	&time	1636	&time
1426	}	1637	}
1427		1638
1428	*now = \&time;	1639	*now = \&time;
1429
1430	sub now_update { }	1640	sub now_update { }
1431		1641
		1642	sub _poll {
		1643	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1644	}
		1645
1432	# default implementation for ->condvar	1646	# default implementation for ->condvar
		1647	# in fact, the default should not be overwritten
1433		1648
1434	sub condvar {	1649	sub condvar {
1435	eval q{ # poor man's autoloading {}	1650	eval q{ # poor man's autoloading {}
1436	*condvar = sub {	1651	*condvar = sub {
1437	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1652	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1515		1730
1516	sub signal {	1731	sub signal {
1517	eval q{ # poor man's autoloading {}	1732	eval q{ # poor man's autoloading {}
1518	# probe for availability of Async::Interrupt	1733	# probe for availability of Async::Interrupt
1519	if (_have_async_interrupt) {	1734	if (_have_async_interrupt) {
1520	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1735	AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1521		1736
1522	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1737	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1523	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1738	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1524		1739
1525	} else {	1740	} else {
1526	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1741	AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
1527		1742
1528	if (AnyEvent::WIN32) {	1743	if (AnyEvent::WIN32) {
1529	require AnyEvent::Util;	1744	require AnyEvent::Util;
1530		1745
1531	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1746	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1607	: sysread $SIGPIPE_R, (my $dummy), 9;	1822	: sysread $SIGPIPE_R, (my $dummy), 9;
1608		1823
1609	while (%SIG_EV) {	1824	while (%SIG_EV) {
1610	for (keys %SIG_EV) {	1825	for (keys %SIG_EV) {
1611	delete $SIG_EV{$_};	1826	delete $SIG_EV{$_};
1612	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1827	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1613	}	1828	}
1614	}	1829	}
1615	};	1830	};
1616	};	1831	};
1617	die if $@;	1832	die if $@;
…		…
1622	# default implementation for ->child	1837	# default implementation for ->child
1623		1838
1624	our %PID_CB;	1839	our %PID_CB;
1625	our $CHLD_W;	1840	our $CHLD_W;
1626	our $CHLD_DELAY_W;	1841	our $CHLD_DELAY_W;
1627	our $WNOHANG;
1628		1842
1629	# used by many Impl's	1843	# used by many Impl's
1630	sub _emit_childstatus($$) {	1844	sub _emit_childstatus($$) {
1631	my (undef, $rpid, $rstatus) = @_;	1845	my (undef, $rpid, $rstatus) = @_;
1632		1846
…		…
1639	eval q{ # poor man's autoloading {}	1853	eval q{ # poor man's autoloading {}
1640	*_sigchld = sub {	1854	*_sigchld = sub {
1641	my $pid;	1855	my $pid;
1642		1856
1643	AnyEvent->_emit_childstatus ($pid, $?)	1857	AnyEvent->_emit_childstatus ($pid, $?)
1644	while ($pid = waitpid -1, $WNOHANG) > 0;	1858	while ($pid = waitpid -1, WNOHANG) > 0;
1645	};	1859	};
1646		1860
1647	*child = sub {	1861	*child = sub {
1648	my (undef, %arg) = @_;	1862	my (undef, %arg) = @_;
1649		1863
1650	defined (my $pid = $arg{pid} + 0)	1864	my $pid = $arg{pid};
1651	or Carp::croak "required option 'pid' is missing";	1865	my $cb = $arg{cb};
1652		1866
1653	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1867	$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		1868
1660	unless ($CHLD_W) {	1869	unless ($CHLD_W) {
1661	$CHLD_W = AE::signal CHLD => \&_sigchld;	1870	$CHLD_W = AE::signal CHLD => \&_sigchld;
1662	# child could be a zombie already, so make at least one round	1871	# child could be a zombie already, so make at least one round
1663	&_sigchld;	1872	&_sigchld;
1664	}	1873	}
1665		1874
1666	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1875	bless [$pid, $cb+0], "AnyEvent::Base::child"
1667	};	1876	};
1668		1877
1669	*AnyEvent::Base::child::DESTROY = sub {	1878	*AnyEvent::Base::child::DESTROY = sub {
1670	my ($pid, $cb) = @{$_[0]};	1879	my ($pid, $icb) = @{$_[0]};
1671		1880
1672	delete $PID_CB{$pid}{$cb};	1881	delete $PID_CB{$pid}{$icb};
1673	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1882	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1674		1883
1675	undef $CHLD_W unless keys %PID_CB;	1884	undef $CHLD_W unless keys %PID_CB;
1676	};	1885	};
1677	};	1886	};
…		…
1690		1899
1691	my ($cb, $w, $rcb) = $arg{cb};	1900	my ($cb, $w, $rcb) = $arg{cb};
1692		1901
1693	$rcb = sub {	1902	$rcb = sub {
1694	if ($cb) {	1903	if ($cb) {
1695	$w = _time;	1904	$w = AE::time;
1696	&$cb;	1905	&$cb;
1697	$w = _time - $w;	1906	$w = AE::time - $w;
1698		1907
1699	# never use more then 50% of the time for the idle watcher,	1908	# never use more then 50% of the time for the idle watcher,
1700	# within some limits	1909	# within some limits
1701	$w = 0.0001 if $w < 0.0001;	1910	$w = 0.0001 if $w < 0.0001;
1702	$w = 5 if $w > 5;	1911	$w = 5 if $w > 5;
…		…
1725		1934
1726	package AnyEvent::CondVar;	1935	package AnyEvent::CondVar;
1727		1936
1728	our @ISA = AnyEvent::CondVar::Base::;	1937	our @ISA = AnyEvent::CondVar::Base::;
1729		1938
		1939	# only to be used for subclassing
		1940	sub new {
		1941	my $class = shift;
		1942	bless AnyEvent->condvar (@_), $class
		1943	}
		1944
1730	package AnyEvent::CondVar::Base;	1945	package AnyEvent::CondVar::Base;
1731		1946
1732	#use overload	1947	#use overload
1733	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1948	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1734	# fallback => 1;	1949	# fallback => 1;
…		…
1743		1958
1744	sub _send {	1959	sub _send {
1745	# nop	1960	# nop
1746	}	1961	}
1747		1962
		1963	sub _wait {
		1964	AnyEvent->_poll until $_[0]{_ae_sent};
		1965	}
		1966
1748	sub send {	1967	sub send {
1749	my $cv = shift;	1968	my $cv = shift;
1750	$cv->{_ae_sent} = [@_];	1969	$cv->{_ae_sent} = [@_];
1751	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1970	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1752	$cv->_send;	1971	$cv->_send;
…		…
1759		1978
1760	sub ready {	1979	sub ready {
1761	$_[0]{_ae_sent}	1980	$_[0]{_ae_sent}
1762	}	1981	}
1763		1982
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 {	1983	sub recv {
		1984	unless ($_[0]{_ae_sent}) {
		1985	$WAITING
		1986	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1987
		1988	local $WAITING = 1;
1774	$_[0]->_wait;	1989	$_[0]->_wait;
		1990	}
1775		1991
1776	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1992	$_[0]{_ae_croak}
1777	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1993	and Carp::croak $_[0]{_ae_croak};
		1994
		1995	wantarray
		1996	? @{ $_[0]{_ae_sent} }
		1997	: $_[0]{_ae_sent}[0]
1778	}	1998	}
1779		1999
1780	sub cb {	2000	sub cb {
1781	my $cv = shift;	2001	my $cv = shift;
1782		2002
…		…
1798	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	2018	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1799	}	2019	}
1800		2020
1801	# undocumented/compatibility with pre-3.4	2021	# undocumented/compatibility with pre-3.4
1802	*broadcast = \&send;	2022	*broadcast = \&send;
1803	*wait = \&_wait;	2023	*wait = \&recv;
1804		2024
1805	=head1 ERROR AND EXCEPTION HANDLING	2025	=head1 ERROR AND EXCEPTION HANDLING
1806		2026
1807	In general, AnyEvent does not do any error handling - it relies on the	2027	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	2028	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1820	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2040	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1821	so on.	2041	so on.
1822		2042
1823	=head1 ENVIRONMENT VARIABLES	2043	=head1 ENVIRONMENT VARIABLES
1824		2044
1825	The following environment variables are used by this module or its	2045	AnyEvent supports a number of environment variables that tune the
1826	submodules.	2046	runtime behaviour. They are usually evaluated when AnyEvent is
		2047	loaded, initialised, or a submodule that uses them is loaded. Many of
		2048	them also cause AnyEvent to load additional modules - for example,
		2049	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2050	loaded.
1827		2051
1828	Note that AnyEvent will remove I<all> environment variables starting with	2052	All the environment variables documented here start with
1829	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2053	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1830	enabled.	2054	namespace. Other modules are encouraged (but by no means required) to use
		2055	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2056	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2057	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2058	variables starting with C<AE_>, see below).
		2059
		2060	All variables can also be set via the C<AE_> prefix, that is, instead
		2061	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2062	case there is a clash btween anyevent and another program that uses
		2063	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2064	variable to the empty string, as those variables take precedence.
		2065
		2066	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2067	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2068	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2069	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2070	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2071	is set).
		2072
		2073	The exact algorithm is currently:
		2074
		2075	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2076	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2077	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2078
		2079	This ensures that child processes will not see the C<AE_> variables.
		2080
		2081	The following environment variables are currently known to AnyEvent:
1831		2082
1832	=over 4	2083	=over 4
1833		2084
1834	=item C<PERL_ANYEVENT_VERBOSE>	2085	=item C<PERL_ANYEVENT_VERBOSE>
1835		2086
1836	By default, AnyEvent will be completely silent except in fatal	2087	By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
1837	conditions. You can set this environment variable to make AnyEvent more	2088	higher (see L<AnyEvent::Log>). You can set this environment variable to a
1838	talkative.	2089	numerical loglevel to make AnyEvent more (or less) talkative.
1839		2090
		2091	If you want to do more than just set the global logging level
		2092	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2093	complex specifications.
		2094
		2095	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2096	everything else at defaults.
		2097
1840	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2098	When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
1841	conditions, such as not being able to load the event model specified by	2099	conditions, such as not being able to load the event model specified by
1842	C<PERL_ANYEVENT_MODEL>.	2100	C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
		2101	is the minimum recommended level for use during development.
1843		2102
1844	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2103	When set to C<7> or higher (info), AnyEvent reports which event model it
1845	model it chooses.	2104	chooses.
1846		2105
1847	When set to C<8> or higher, then AnyEvent will report extra information on	2106	When set to C<8> or higher (debug), then AnyEvent will report extra
1848	which optional modules it loads and how it implements certain features.	2107	information on which optional modules it loads and how it implements
		2108	certain features.
		2109
		2110	=item C<PERL_ANYEVENT_LOG>
		2111
		2112	Accepts rather complex logging specifications. For example, you could log
		2113	all C<debug> messages of some module to stderr, warnings and above to
		2114	stderr, and errors and above to syslog, with:
		2115
		2116	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2117
		2118	For the rather extensive details, see L<AnyEvent::Log>.
		2119
		2120	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2121	so will take effect even before AnyEvent has initialised itself.
		2122
		2123	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2124	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2125	using the latter saves a few hundred kB of memory unless a module
		2126	explicitly needs the extra features of AnyEvent::Log.
1849		2127
1850	=item C<PERL_ANYEVENT_STRICT>	2128	=item C<PERL_ANYEVENT_STRICT>
1851		2129
1852	AnyEvent does not do much argument checking by default, as thorough	2130	AnyEvent does not do much argument checking by default, as thorough
1853	argument checking is very costly. Setting this variable to a true value	2131	argument checking is very costly. Setting this variable to a true value
…		…
1860	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2138	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1861	>>, it is definitely recommended to keep it off in production. Keeping	2139	>>, it is definitely recommended to keep it off in production. Keeping
1862	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2140	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1863	can be very useful, however.	2141	can be very useful, however.
1864		2142
		2143	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2144
		2145	If this env variable is nonempty, then its contents will be interpreted by
		2146	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2147	replacing every occurance of C<$$> by the process pid). The shell object
		2148	is saved in C<$AnyEvent::Debug::SHELL>.
		2149
		2150	This happens when the first watcher is created.
		2151
		2152	For example, to bind a debug shell on a unix domain socket in
		2153	F<< /tmp/debug<pid>.sock >>, you could use this:
		2154
		2155	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2156	# connect with e.g.: socat readline /tmp/debug123.sock
		2157
		2158	Or to bind to tcp port 4545 on localhost:
		2159
		2160	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2161	# connect with e.g.: telnet localhost 4545
		2162
		2163	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2164	multiuser systems.
		2165
		2166	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2167
		2168	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2169	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2170
1865	=item C<PERL_ANYEVENT_MODEL>	2171	=item C<PERL_ANYEVENT_MODEL>
1866		2172
1867	This can be used to specify the event model to be used by AnyEvent, before	2173	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	2174	auto detection and -probing kicks in.
1869	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2175
		2176	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2177	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,	2178	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	2179	event model backend. If it fails to load then AnyEvent will proceed with
1872	auto detection and -probing.	2180	auto detection and -probing.
1873		2181
1874	This functionality might change in future versions.	2182	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2183	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2184	the end of a string designates a module name and quotes it appropriately).
1875		2185
1876	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2186	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1877	could start your program like this:	2187	could start your program like this:
1878		2188
1879	PERL_ANYEVENT_MODEL=Perl perl ...	2189	PERL_ANYEVENT_MODEL=Perl perl ...
		2190
		2191	=item C<PERL_ANYEVENT_IO_MODEL>
		2192
		2193	The current file I/O model - see L<AnyEvent::IO> for more info.
		2194
		2195	At the moment, only C<Perl> (small, pure-perl, synchronous) and
		2196	C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
		2197	L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
1880		2198
1881	=item C<PERL_ANYEVENT_PROTOCOLS>	2199	=item C<PERL_ANYEVENT_PROTOCOLS>
1882		2200
1883	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences	2201	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1884	for IPv4 or IPv6. The default is unspecified (and might change, or be the result	2202	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
…		…
1897	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2215	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1898	- only support IPv4, never try to resolve or contact IPv6	2216	- only support IPv4, never try to resolve or contact IPv6
1899	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2217	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1900	IPv6, but prefer IPv6 over IPv4.	2218	IPv6, but prefer IPv6 over IPv4.
1901		2219
		2220	=item C<PERL_ANYEVENT_HOSTS>
		2221
		2222	This variable, if specified, overrides the F</etc/hosts> file used by
		2223	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2224	from that file instead.
		2225
1902	=item C<PERL_ANYEVENT_EDNS0>	2226	=item C<PERL_ANYEVENT_EDNS0>
1903		2227
1904	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2228	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1905	for DNS. This extension is generally useful to reduce DNS traffic, but	2229	DNS. This extension is generally useful to reduce DNS traffic, especially
1906	some (broken) firewalls drop such DNS packets, which is why it is off by	2230	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1907	default.	2231	packets, which is why it is off by default.
1908		2232
1909	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2233	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1910	EDNS0 in its DNS requests.	2234	EDNS0 in its DNS requests.
1911		2235
1912	=item C<PERL_ANYEVENT_MAX_FORKS>	2236	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1918		2242
1919	The default value for the C<max_outstanding> parameter for the default DNS	2243	The default value for the C<max_outstanding> parameter for the default DNS
1920	resolver - this is the maximum number of parallel DNS requests that are	2244	resolver - this is the maximum number of parallel DNS requests that are
1921	sent to the DNS server.	2245	sent to the DNS server.
1922		2246
		2247	=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
		2248
		2249	Perl has inherently racy signal handling (you can basically choose between
		2250	losing signals and memory corruption) - pure perl event loops (including
		2251	C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
		2252	have to poll regularly to avoid losing signals.
		2253
		2254	Some event loops are racy, but don't poll regularly, and some event loops
		2255	are written in C but are still racy. For those event loops, AnyEvent
		2256	installs a timer that regularly wakes up the event loop.
		2257
		2258	By default, the interval for this timer is C<10> seconds, but you can
		2259	override this delay with this environment variable (or by setting
		2260	the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
		2261	watchers).
		2262
		2263	Lower values increase CPU (and energy) usage, higher values can introduce
		2264	long delays when reaping children or waiting for signals.
		2265
		2266	The L<AnyEvent::Async> module, if available, will be used to avoid this
		2267	polling (with most event loops).
		2268
1923	=item C<PERL_ANYEVENT_RESOLV_CONF>	2269	=item C<PERL_ANYEVENT_RESOLV_CONF>
1924		2270
1925	The file to use instead of F</etc/resolv.conf> (or OS-specific	2271	The absolute path to a F<resolv.conf>-style file to use instead of
1926	configuration) in the default resolver. When set to the empty string, no	2272	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1927	default config will be used.	2273	resolver, or the empty string to select the default configuration.
1928		2274
1929	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2275	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1930		2276
1931	When neither C<ca_file> nor C<ca_path> was specified during	2277	When neither C<ca_file> nor C<ca_path> was specified during
1932	L<AnyEvent::TLS> context creation, and either of these environment	2278	L<AnyEvent::TLS> context creation, and either of these environment
1933	variables exist, they will be used to specify CA certificate locations	2279	variables are nonempty, they will be used to specify CA certificate
1934	instead of a system-dependent default.	2280	locations instead of a system-dependent default.
1935		2281
1936	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2282	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1937		2283
1938	When these are set to C<1>, then the respective modules are not	2284	When these are set to C<1>, then the respective modules are not
1939	loaded. Mostly good for testing AnyEvent itself.	2285	loaded. Mostly good for testing AnyEvent itself.
…		…
2271	(even when used without AnyEvent), but most event loops have acceptable	2617	(even when used without AnyEvent), but most event loops have acceptable
2272	performance with or without AnyEvent.	2618	performance with or without AnyEvent.
2273		2619
2274	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2620	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2275	the actual event loop, only with extremely fast event loops such as EV	2621	the actual event loop, only with extremely fast event loops such as EV
2276	adds AnyEvent significant overhead.	2622	does AnyEvent add significant overhead.
2277		2623
2278	=item * You should avoid POE like the plague if you want performance or	2624	=item * You should avoid POE like the plague if you want performance or
2279	reasonable memory usage.	2625	reasonable memory usage.
2280		2626
2281	=back	2627	=back
…		…
2580		2926
2581	=item L<Time::HiRes>	2927	=item L<Time::HiRes>
2582		2928
2583	This module is part of perl since release 5.008. It will be used when the	2929	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	2930	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	2931	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2586	try to use a monotonic clock for timing stability.	2932	try to use a monotonic clock for timing stability.
		2933
		2934	=item L<AnyEvent::AIO> (and L<IO::AIO>)
		2935
		2936	The default implementation of L<AnyEvent::IO> is to do I/O synchronously,
		2937	stopping programs while they access the disk, which is fine for a lot of
		2938	programs.
		2939
		2940	Installing AnyEvent::AIO (and its IO::AIO dependency) makes it switch to
		2941	a true asynchronous implementation, so event processing can continue even
		2942	while waiting for disk I/O.
2587		2943
2588	=back	2944	=back
2589		2945
2590		2946
2591	=head1 FORK	2947	=head1 FORK
…		…
2652	pronounced).	3008	pronounced).
2653		3009
2654		3010
2655	=head1 SEE ALSO	3011	=head1 SEE ALSO
2656		3012
2657	Utility functions: L<AnyEvent::Util>.	3013	Tutorial/Introduction: L<AnyEvent::Intro>.
2658		3014
2659	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	3015	FAQ: L<AnyEvent::FAQ>.
2660	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	3016
		3017	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		3018	(simply logging).
		3019
		3020	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		3021	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		3022
		3023	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		3024	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		3025	L<Qt>, L<POE>, L<FLTK>.
2661		3026
2662	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	3027	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	3028	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	3029	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	3030	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		3031	L<AnyEvent::Impl::FLTK>.
2666		3032
2667	Non-blocking file handles, sockets, TCP clients and	3033	Non-blocking handles, pipes, stream sockets, TCP clients and
2668	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	3034	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669		3035
		3036	Asynchronous File I/O: L<AnyEvent::IO>.
		3037
2670	Asynchronous DNS: L<AnyEvent::DNS>.	3038	Asynchronous DNS: L<AnyEvent::DNS>.
2671		3039
2672	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	3040	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2673	L<Coro::Event>,
2674		3041
2675	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	3042	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2676	L<AnyEvent::HTTP>.	3043	L<AnyEvent::HTTP>.
2677		3044
2678		3045
2679	=head1 AUTHOR	3046	=head1 AUTHOR
2680		3047
2681	Marc Lehmann <schmorp@schmorp.de>	3048	Marc Lehmann <schmorp@schmorp.de>
2682	http://home.schmorp.de/	3049	http://anyevent.schmorp.de
2683		3050
2684	=cut	3051	=cut
2685		3052
2686	1	3053	1
2687		3054

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.331 by root, Tue Aug 31 01:00:48 2010 UTC vs. Revision 1.410 by root, Fri Mar 1 06:03:21 2013 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.331 by root, Tue Aug 31 01:00:48 2010 UTC vs.
Revision 1.410 by root, Fri Mar 1 06:03:21 2013 UTC