ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.320 by root, Mon Apr 12 02:50:31 2010 UTC vs.
Revision 1.383 by root, Fri Sep 2 04:41:16 2011 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
12	# if you prefer function calls, look at the L<AE> manpage for	12	# if you prefer function calls, look at the AE manpage for
13	# an alternative API.	13	# an alternative API.
14		14
15	# file handle or descriptor readable	15	# file handle or descriptor readable
16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
17		17
18	# one-shot or repeating timers	18	# one-shot or repeating timers
19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
21		21
22	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
24		24
25	# POSIX signal	25	# POSIX signal
…		…
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
…		…
76	module users into the same thing by forcing them to use the same event	78	module users into the same thing by forcing them to use the same event
77	model you use.	79	model you use.
78		80
79	For modules like POE or IO::Async (which is a total misnomer as it is	81	For modules like POE or IO::Async (which is a total misnomer as it is
80	actually doing all I/O I<synchronously>...), using them in your module is	82	actually doing all I/O I<synchronously>...), using them in your module is
81	like joining a cult: After you joined, you are dependent on them and you	83	like joining a cult: After you join, you are dependent on them and you
82	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
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 trivial 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 up to the point, by only	100	follow. AnyEvent, on the other hand, is lean and to the point, by only
99	offering the functionality that is necessary, in as thin as a wrapper as	101	offering the functionality that is necessary, in as thin as a wrapper as
100	technically possible.	102	technically possible.
101		103
102	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
103	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
109	useful) and you want to force your users to use the one and only event	111	useful) and you want to force your users to use the one and only event
110	model, you should I<not> use this module.	112	model, you should I<not> use this module.
111		113
112	=head1 DESCRIPTION	114	=head1 DESCRIPTION
113		115
114	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
115	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
116	users to use the same event loop (as only a single event loop can coexist	118	module users to use a specific event loop implementation (since more
117	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
118		120
119	The interface itself is vaguely similar, but not identical to the L<Event>	121	The interface itself is vaguely similar, but not identical to the L<Event>
120	module.	122	module.
121		123
122	During the first call of any watcher-creation method, the module tries	124	During the first call of any watcher-creation method, the module tries
123	to detect the currently loaded event loop by probing whether one of the	125	to detect the currently loaded event loop by probing whether one of the
124	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
126	L<POE>. The first one found is used. If none are found, the module tries	128	found is used. If none are detected, the module tries to load the first
127	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	129	four modules in the order given; but note that if L<EV> is not
128	adaptor should always succeed) in the order given. The first one that can	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
129	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
130	found, AnyEvent will fall back to a pure-perl event loop, which is not
131	very efficient, but should work everywhere.
132		132
133	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
134	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
135	that model the default. For example:	135	that model the default. For example:
136		136
…		…
138	use AnyEvent;	138	use AnyEvent;
139		139
140	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
141		141
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. Maybe you should tell their authors to	143	starts using it, all bets are off - this case should be very rare though,
144	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
145		146
146	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
147	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
148	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
149		150
150	=head1 WATCHERS	151	=head1 WATCHERS
151		152
152	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
153	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
…		…
158	callback when the event occurs (of course, only when the event model	159	callback when the event occurs (of course, only when the event model
159	is in control).	160	is in control).
160		161
161	Note that B<callbacks must not permanently change global variables>	162	Note that B<callbacks must not permanently change global variables>
162	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<	163	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
163	callbacks must not C<die> >>. The former is good programming practise in	164	callbacks must not C<die> >>. The former is good programming practice in
164	Perl and the latter stems from the fact that exception handling differs	165	Perl and the latter stems from the fact that exception handling differs
165	widely between event loops.	166	widely between event loops.
166		167
167	To disable the watcher you have to destroy it (e.g. by setting the	168	To disable a watcher you have to destroy it (e.g. by setting the
168	variable you store it in to C<undef> or otherwise deleting all references	169	variable you store it in to C<undef> or otherwise deleting all references
169	to it).	170	to it).
170		171
171	All watchers are created by calling a method on the C<AnyEvent> class.	172	All watchers are created by calling a method on the C<AnyEvent> class.
172		173
173	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
174	example), or need to refer to their watcher object in other ways.	175	example), or need to refer to their watcher object in other ways.
175		176
176	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
177		178
178	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
179	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
180	undef $w;	181	undef $w;
181	});	182	});
…		…
213		214
214	The I/O watcher might use the underlying file descriptor or a copy of it.	215	The I/O watcher might use the underlying file descriptor or a copy of it.
215	You must not close a file handle as long as any watcher is active on the	216	You must not close a file handle as long as any watcher is active on the
216	underlying file descriptor.	217	underlying file descriptor.
217		218
218	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
219	always use non-blocking calls when reading/writing from/to your file	220	always use non-blocking calls when reading/writing from/to your file
220	handles.	221	handles.
221		222
222	Example: wait for readability of STDIN, then read a line and disable the	223	Example: wait for readability of STDIN, then read a line and disable the
223	watcher.	224	watcher.
…		…
247		248
248	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
249	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
250	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
251		252
252	The callback will normally be invoked once only. If you specify another	253	The callback will normally be invoked only once. If you specify another
253	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
254	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
255	seconds) after the first invocation. If C<interval> is specified with a	256	seconds) after the first invocation. If C<interval> is specified with a
256	false value, then it is treated as if it were missing.	257	false value, then it is treated as if it were not specified at all.
257		258
258	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
259	attempt is done to avoid timer drift in most backends, so the interval is	260	attempt is made to avoid timer drift in most backends, so the interval is
260	only approximate.	261	only approximate.
261		262
262	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
263		264
264	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
282		283
283	While most event loops expect timers to specified in a relative way, they	284	While most event loops expect timers to specified in a relative way, they
284	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
285	"jumps", for example, when ntp decides to set your clock backwards from	286	"jumps", for example, when ntp decides to set your clock backwards from
286	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to	287	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
287	fire "after" a second might actually take six years to finally fire.	288	fire "after a second" might actually take six years to finally fire.
288		289
289	AnyEvent cannot compensate for this. The only event loop that is conscious	290	AnyEvent cannot compensate for this. The only event loop that is conscious
290	about these issues is L<EV>, which offers both relative (ev_timer, based	291	of these issues is L<EV>, which offers both relative (ev_timer, based
291	on true relative time) and absolute (ev_periodic, based on wallclock time)	292	on true relative time) and absolute (ev_periodic, based on wallclock time)
292	timers.	293	timers.
293		294
294	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
295	AnyEvent API.	296	AnyEvent API.
…		…
317	I<In almost all cases (in all cases if you don't care), this is the	318	I<In almost all cases (in all cases if you don't care), this is the
318	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
319		320
320	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
321	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
322	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
323		324
324	The rest of this section is only of relevance if you try to be very exact	325	The rest of this section is only of relevance if you try to be very exact
325	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
326		327
327	For a practical example of when these times differ, consider L<Event::Lib>	328	For a practical example of when these times differ, consider L<Event::Lib>
328	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
329		330
330	The event loop is running and has just invoked one of your callback at	331	The event loop is running and has just invoked one of your callbacks at
331	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
332	you wait a second by executing C<sleep 1> (blocking the process for a	333	you wait a second by executing C<sleep 1> (blocking the process for a
333	second) and then (at time=501) you create a relative timer that fires	334	second) and then (at time=501) you create a relative timer that fires
334	after three seconds.	335	after three seconds.
335		336
…		…
355	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
356	account.	357	account.
357		358
358	=item AnyEvent->now_update	359	=item AnyEvent->now_update
359		360
360	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
361	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 >>,
362	AnyEvent->now >>, above).	363	above).
363		364
364	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
365	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
366	might affect timers and time-outs.	367	might affect timers and time-outs.
367		368
…		…
428	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
429		430
430	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 attaching
431	callbacks to signals in a generic way, which is a pity, as you cannot	432	callbacks to signals in a generic way, which is a pity, as you cannot
432	do race-free signal handling in perl, requiring C libraries for	433	do race-free signal handling in perl, requiring C libraries for
433	this. AnyEvent will try to do it's best, which means in some cases,	434	this. AnyEvent will try to do its best, which means in some cases,
434	signals will be delayed. The maximum time a signal might be delayed is	435	signals will be delayed. The maximum time a signal might be delayed is
435	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
436	variable can be changed only before the first signal watcher is created,	437	variable can be changed only before the first signal watcher is created,
437	and should be left alone otherwise. This variable determines how often	438	and should be left alone otherwise. This variable determines how often
438	AnyEvent polls for signals (in case a wake-up was missed). Higher values	439	AnyEvent polls for signals (in case a wake-up was missed). Higher values
…		…
440	saving.	441	saving.
441		442
442	All these problems can be avoided by installing the optional	443	All these problems can be avoided by installing the optional
443	L<Async::Interrupt> module, which works with most event loops. It will not	444	L<Async::Interrupt> module, which works with most event loops. It will not
444	work with inherently broken event loops such as L<Event> or L<Event::Lib>	445	work with inherently broken event loops such as L<Event> or L<Event::Lib>
445	(and not with L<POE> currently, as POE does it's own workaround with	446	(and not with L<POE> currently, as POE does its own workaround with
446	one-second latency). For those, you just have to suffer the delays.	447	one-second latency). For those, you just have to suffer the delays.
447		448
448	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
449		450
450	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
451		452
452	You can also watch on a child process exit and catch its exit status.	453	You can also watch for a child process exit and catch its exit status.
453		454
454	The child process is specified by the C<pid> argument (one some backends,	455	The child process is specified by the C<pid> argument (on some backends,
455	using C<0> watches for any child process exit, on others this will	456	using C<0> watches for any child process exit, on others this will
456	croak). The watcher will be triggered only when the child process has	457	croak). The watcher will be triggered only when the child process has
457	finished and an exit status is available, not on any trace events	458	finished and an exit status is available, not on any trace events
458	(stopped/continued).	459	(stopped/continued).
459		460
…		…
481	thing in an AnyEvent program, you I<have> to create at least one	482	thing in an AnyEvent program, you I<have> to create at least one
482	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
483	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
484		485
485	As most event loops do not support waiting for child events, they will be	486	As most event loops do not support waiting for child events, they will be
486	emulated by AnyEvent in most cases, in which the latency and race problems	487	emulated by AnyEvent in most cases, in which case the latency and race
487	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
488		489
489	Example: fork a process and wait for it	490	Example: fork a process and wait for it
490		491
491	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
492		493
…		…
506		507
507	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
508		509
509	$w = AnyEvent->idle (cb => <callback>);	510	$w = AnyEvent->idle (cb => <callback>);
510		511
511	Repeatedly invoke the callback after the process becomes idle, until	512	This will repeatedly invoke the callback after the process becomes idle,
512	either the watcher is destroyed or new events have been detected.	513	until either the watcher is destroyed or new events have been detected.
513		514
514	Idle watchers are useful when there is a need to do something, but it	515	Idle watchers are useful when there is a need to do something, but it
515	is not so important (or wise) to do it instantly. The callback will be	516	is not so important (or wise) to do it instantly. The callback will be
516	invoked only when there is "nothing better to do", which is usually	517	invoked only when there is "nothing better to do", which is usually
517	defined as "all outstanding events have been handled and no new events	518	defined as "all outstanding events have been handled and no new events
…		…
556	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
557		558
558	AnyEvent is slightly different: it expects somebody else to run the event	559	AnyEvent is slightly different: it expects somebody else to run the event
559	loop and will only block when necessary (usually when told by the user).	560	loop and will only block when necessary (usually when told by the user).
560		561
561	The instrument to do that is called a "condition variable", so called	562	The tool to do that is called a "condition variable", so called because
562	because they represent a condition that must become true.	563	they represent a condition that must become true.
563		564
564	Now is probably a good time to look at the examples further below.	565	Now is probably a good time to look at the examples further below.
565		566
566	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
567	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
…		…
572	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
573	by calling the C<send> method (or calling the condition variable as if it	574	by calling the C<send> method (or calling the condition variable as if it
574	were a callback, read about the caveats in the description for the C<<	575	were a callback, read about the caveats in the description for the C<<
575	->send >> method).	576	->send >> method).
576		577
577	Condition variables are similar to callbacks, except that you can	578	Since condition variables are the most complex part of the AnyEvent API, here are
578	optionally wait for them. They can also be called merge points - points	579	some different mental models of what they are - pick the ones you can connect to:
579	in time where multiple outstanding events have been processed. And yet	580
580	another way to call them is transactions - each condition variable can be	581	=over 4
581	used to represent a transaction, which finishes at some point and delivers	582
582	a result. And yet some people know them as "futures" - a promise to	583	=item * Condition variables are like callbacks - you can call them (and pass them instead
583	compute/deliver something that you can wait for.	584	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		585
		586	=item * Condition variables are signals - one side can emit or send them,
		587	the other side can wait for them, or install a handler that is called when
		588	the signal fires.
		589
		590	=item * Condition variables are like "Merge Points" - points in your program
		591	where you merge multiple independent results/control flows into one.
		592
		593	=item * Condition variables represent a transaction - functions that start
		594	some kind of transaction can return them, leaving the caller the choice
		595	between waiting in a blocking fashion, or setting a callback.
		596
		597	=item * Condition variables represent future values, or promises to deliver
		598	some result, long before the result is available.
		599
		600	=back
584		601
585	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
586	for example, if you write a module that does asynchronous http requests,	603	for example, if you write a module that does asynchronous http requests,
587	then a condition variable would be the ideal candidate to signal the	604	then a condition variable would be the ideal candidate to signal the
588	availability of results. The user can either act when the callback is	605	availability of results. The user can either act when the callback is
…		…
601		618
602	Condition variables are represented by hash refs in perl, and the keys	619	Condition variables are represented by hash refs in perl, and the keys
603	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing	620	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
604	easy (it is often useful to build your own transaction class on top of	621	easy (it is often useful to build your own transaction class on top of
605	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call	622	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
606	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
607		624
608	There are two "sides" to a condition variable - the "producer side" which	625	There are two "sides" to a condition variable - the "producer side" which
609	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
610	for the send to occur.	627	for the send to occur.
611		628
…		…
676	they were a code reference). Calling them directly is the same as calling	693	they were a code reference). Calling them directly is the same as calling
677	C<send>.	694	C<send>.
678		695
679	=item $cv->croak ($error)	696	=item $cv->croak ($error)
680		697
681	Similar to send, but causes all call's to C<< ->recv >> to invoke	698	Similar to send, but causes all calls to C<< ->recv >> to invoke
682	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
683		700
684	This can be used to signal any errors to the condition variable	701	This can be used to signal any errors to the condition variable
685	user/consumer. Doing it this way instead of calling C<croak> directly	702	user/consumer. Doing it this way instead of calling C<croak> directly
686	delays the error detetcion, but has the overwhelmign advantage that it	703	delays the error detection, but has the overwhelming advantage that it
687	diagnoses the error at the place where the result is expected, and not	704	diagnoses the error at the place where the result is expected, and not
688	deep in some event clalback without connection to the actual code causing	705	deep in some event callback with no connection to the actual code causing
689	the problem.	706	the problem.
690		707
691	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
692		709
693	=item $cv->end	710	=item $cv->end
…		…
731	one call to C<begin>, so the condvar waits for all calls to C<end> before	748	one call to C<begin>, so the condvar waits for all calls to C<end> before
732	sending.	749	sending.
733		750
734	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
735	there are results to be passwd back, and the number of tasks that are	752	there are results to be passwd back, and the number of tasks that are
736	begung can potentially be zero:	753	begun can potentially be zero:
737		754
738	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
739		756
740	my %result;	757	my %result;
741	$cv->begin (sub { shift->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
…		…
762	to be called once the counter reaches C<0>, and second, it ensures that	779	to be called once the counter reaches C<0>, and second, it ensures that
763	C<send> is called even when C<no> hosts are being pinged (the loop	780	C<send> is called even when C<no> hosts are being pinged (the loop
764	doesn't execute once).	781	doesn't execute once).
765		782
766	This is the general pattern when you "fan out" into multiple (but	783	This is the general pattern when you "fan out" into multiple (but
767	potentially none) subrequests: use an outer C<begin>/C<end> pair to set	784	potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
768	the callback and ensure C<end> is called at least once, and then, for each	785	the callback and ensure C<end> is called at least once, and then, for each
769	subrequest you start, call C<begin> and for each subrequest you finish,	786	subrequest you start, call C<begin> and for each subrequest you finish,
770	call C<end>.	787	call C<end>.
771		788
772	=back	789	=back
…		…
779	=over 4	796	=over 4
780		797
781	=item $cv->recv	798	=item $cv->recv
782		799
783	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
784	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
785	normally.	802	normally.
786		803
787	You can only wait once on a condition - additional calls are valid but	804	You can only wait once on a condition - additional calls are valid but
788	will return immediately.	805	will return immediately.
789		806
…		…
806	caller decide whether the call will block or not (for example, by coupling	823	caller decide whether the call will block or not (for example, by coupling
807	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
808	callbacks so the caller knows that getting the result will not block,	825	callbacks so the caller knows that getting the result will not block,
809	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
810		827
811	You can ensure that C<< -recv >> never blocks by setting a callback and	828	You can ensure that C<< ->recv >> never blocks by setting a callback and
812	only calling C<< ->recv >> from within that callback (or at a later	829	only calling C<< ->recv >> from within that callback (or at a later
813	time). This will work even when the event loop does not support blocking	830	time). This will work even when the event loop does not support blocking
814	waits otherwise.	831	waits otherwise.
815		832
816	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
821	=item $cb = $cv->cb ($cb->($cv))	838	=item $cb = $cv->cb ($cb->($cv))
822		839
823	This is a mutator function that returns the callback set and optionally	840	This is a mutator function that returns the callback set and optionally
824	replaces it before doing so.	841	replaces it before doing so.
825		842
826	The callback will be called when the condition becomes (or already was)	843	The callback will be called when the condition becomes "true", i.e. when
827	"true", i.e. when C<send> or C<croak> are called (or were called), with	844	C<send> or C<croak> are called, with the only argument being the
828	the only argument being the condition variable itself. Calling C<recv>	845	condition variable itself. If the condition is already true, the
		846	callback is called immediately when it is set. Calling C<recv> inside
829	inside the callback or at any later time is guaranteed not to block.	847	the callback or at any later time is guaranteed not to block.
830		848
831	=back	849	=back
832		850
833	=head1 SUPPORTED EVENT LOOPS/BACKENDS	851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
834		852
…		…
842	use. If EV is not installed, then AnyEvent will fall back to its own	860	use. If EV is not installed, then AnyEvent will fall back to its own
843	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
844	AnyEvent itself.	862	AnyEvent itself.
845		863
846	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
847	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
848		866
849	=item Backends that are transparently being picked up when they are used.	867	=item Backends that are transparently being picked up when they are used.
850		868
851	These will be used when they are currently loaded when the first watcher	869	These will be used if they are already loaded when the first watcher
852	is created, in which case it is assumed that the application is using	870	is created, in which case it is assumed that the application is using
853	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
854	when the main program loads an event module before anything starts to	872	when the main program loads an event module before anything starts to
855	create watchers. Nothing special needs to be done by the main program.	873	create watchers. Nothing special needs to be done by the main program.
856		874
…		…
858	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
859	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
860	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
861	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
862	AnyEvent::Impl::Irssi used when running within irssi.	880	AnyEvent::Impl::Irssi used when running within irssi.
		881	AnyEvent::Impl::IOAsync based on IO::Async.
		882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
863		884
864	=item Backends with special needs.	885	=item Backends with special needs.
865		886
866	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
867	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
868	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
869	everything should just work.	890	everything should just work.
870		891
871	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
872		893
873	Support for IO::Async can only be partial, as it is too broken and
874	architecturally limited to even support the AnyEvent API. It also
875	is the only event loop that needs the loop to be set explicitly, so
876	it can only be used by a main program knowing about AnyEvent. See
877	L<AnyEvent::Impl::Async> for the gory details.
878
879	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
880
881	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
882		895
883	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
884		897
885	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.	898	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
…		…
910	Contains C<undef> until the first watcher is being created, before the	923	Contains C<undef> until the first watcher is being created, before the
911	backend has been autodetected.	924	backend has been autodetected.
912		925
913	Afterwards it contains the event model that is being used, which is the	926	Afterwards it contains the event model that is being used, which is the
914	name of the Perl class implementing the model. This class is usually one	927	name of the Perl class implementing the model. This class is usually one
915	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the	928	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
916	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it	929	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
917	will be C<urxvt::anyevent>).	930	will be C<urxvt::anyevent>).
918		931
919	=item AnyEvent::detect	932	=item AnyEvent::detect
920		933
921	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
922	if necessary. You should only call this function right before you would	935	if necessary. You should only call this function right before you would
923	have created an AnyEvent watcher anyway, that is, as late as possible at	936	have created an AnyEvent watcher anyway, that is, as late as possible at
924	runtime, and not e.g. while initialising of your module.	937	runtime, and not e.g. during initialisation of your module.
		938
		939	The effect of calling this function is as if a watcher had been created
		940	(specifically, actions that happen "when the first watcher is created"
		941	happen when calling detetc as well).
925		942
926	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
927	created, use C<post_detect>.	944	created, use C<post_detect>.
928		945
929	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
930		947
931	Arranges for the code block to be executed as soon as the event model is	948	Arranges for the code block to be executed as soon as the event model is
932	autodetected (or immediately if this has already happened).	949	autodetected (or immediately if that has already happened).
933		950
934	The block will be executed I<after> the actual backend has been detected	951	The block will be executed I<after> the actual backend has been detected
935	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been	952	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
936	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do	953	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
937	other initialisations - see the sources of L<AnyEvent::Strict> or	954	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
946	that automatically removes the callback again when it is destroyed (or	963	that automatically removes the callback again when it is destroyed (or
947	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for	964	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
948	a case where this is useful.	965	a case where this is useful.
949		966
950	Example: Create a watcher for the IO::AIO module and store it in	967	Example: Create a watcher for the IO::AIO module and store it in
951	C<$WATCHER>. Only do so after the event loop is initialised, though.	968	C<$WATCHER>, but do so only do so after the event loop is initialised.
952		969
953	our WATCHER;	970	our WATCHER;
954		971
955	my $guard = AnyEvent::post_detect {	972	my $guard = AnyEvent::post_detect {
956	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	973	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
964	$WATCHER ||= $guard;	981	$WATCHER ||= $guard;
965		982
966	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
967		984
968	If there are any code references in this array (you can C<push> to it	985	If there are any code references in this array (you can C<push> to it
969	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will be called directly
970	the event loop has been chosen.	987	after the event loop has been chosen.
971		988
972	You should check C<$AnyEvent::MODEL> before adding to this array, though:	989	You should check C<$AnyEvent::MODEL> before adding to this array, though:
973	if it is defined then the event loop has already been detected, and the	990	if it is defined then the event loop has already been detected, and the
974	array will be ignored.	991	array will be ignored.
975		992
…		…
992	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
993	# as soon as it is	1010	# as soon as it is
994	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
995	}	1012	}
996		1013
		1014	=item AnyEvent::postpone { BLOCK }
		1015
		1016	Arranges for the block to be executed as soon as possible, but not before
		1017	the call itself returns. In practise, the block will be executed just
		1018	before the event loop polls for new events, or shortly afterwards.
		1019
		1020	This function never returns anything (to make the C<return postpone { ...
		1021	}> idiom more useful.
		1022
		1023	To understand the usefulness of this function, consider a function that
		1024	asynchronously does something for you and returns some transaction
		1025	object or guard to let you cancel the operation. For example,
		1026	C<AnyEvent::Socket::tcp_connect>:
		1027
		1028	# start a conenction attempt unless one is active
		1029	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1030	delete $self->{connect_guard};
		1031	...
		1032	};
		1033
		1034	Imagine that this function could instantly call the callback, for
		1035	example, because it detects an obvious error such as a negative port
		1036	number. Invoking the callback before the function returns causes problems
		1037	however: the callback will be called and will try to delete the guard
		1038	object. But since the function hasn't returned yet, there is nothing to
		1039	delete. When the function eventually returns it will assign the guard
		1040	object to C<< $self->{connect_guard} >>, where it will likely never be
		1041	deleted, so the program thinks it is still trying to connect.
		1042
		1043	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1044	callback directly on error:
		1045
		1046	$cb->(undef), return # signal error to callback, BAD!
		1047	if $some_error_condition;
		1048
		1049	It should use C<postpone>:
		1050
		1051	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1052	if $some_error_condition;
		1053
		1054	=item AnyEvent::log $level, $msg[, @args]
		1055
		1056	Log the given C<$msg> at the given C<$level>.
		1057
		1058	If L<AnyEvent::Log> is not loaded then this function makes a simple test
		1059	to see whether the message will be logged. If the test succeeds it will
		1060	load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
		1061	the L<AnyEvent::Log> documentation for details.
		1062
		1063	If the test fails it will simply return. Right now this happens when a
		1064	numerical loglevel is used and it is larger than the level specified via
		1065	C<$ENV{PERL_ANYEVENT_VERBOSE}>.
		1066
		1067	If you want to sprinkle loads of logging calls around your code, consider
		1068	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1069	which can reduce typing, codesize and can reduce the logging overhead
		1070	enourmously.
		1071
997	=back	1072	=back
998		1073
999	=head1 WHAT TO DO IN A MODULE	1074	=head1 WHAT TO DO IN A MODULE
1000		1075
1001	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1076	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1011	because it will stall the whole program, and the whole point of using	1086	because it will stall the whole program, and the whole point of using
1012	events is to stay interactive.	1087	events is to stay interactive.
1013		1088
1014	It is fine, however, to call C<< ->recv >> when the user of your module	1089	It is fine, however, to call C<< ->recv >> when the user of your module
1015	requests it (i.e. if you create a http request object ad have a method	1090	requests it (i.e. if you create a http request object ad have a method
1016	called C<results> that returns the results, it should call C<< ->recv >>	1091	called C<results> that returns the results, it may call C<< ->recv >>
1017	freely, as the user of your module knows what she is doing. always).	1092	freely, as the user of your module knows what she is doing. Always).
1018		1093
1019	=head1 WHAT TO DO IN THE MAIN PROGRAM	1094	=head1 WHAT TO DO IN THE MAIN PROGRAM
1020		1095
1021	There will always be a single main program - the only place that should	1096	There will always be a single main program - the only place that should
1022	dictate which event model to use.	1097	dictate which event model to use.
1023		1098
1024	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1099	If the program is not event-based, it need not do anything special, even
1025	do anything special (it does not need to be event-based) and let AnyEvent	1100	when it depends on a module that uses an AnyEvent. If the program itself
1026	decide which implementation to chose if some module relies on it.	1101	uses AnyEvent, but does not care which event loop is used, all it needs
		1102	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1103	available loop implementation.
1027		1104
1028	If the main program relies on a specific event model - for example, in	1105	If the main program relies on a specific event model - for example, in
1029	Gtk2 programs you have to rely on the Glib module - you should load the	1106	Gtk2 programs you have to rely on the Glib module - you should load the
1030	event module before loading AnyEvent or any module that uses it: generally	1107	event module before loading AnyEvent or any module that uses it: generally
1031	speaking, you should load it as early as possible. The reason is that	1108	speaking, you should load it as early as possible. The reason is that
1032	modules might create watchers when they are loaded, and AnyEvent will	1109	modules might create watchers when they are loaded, and AnyEvent will
1033	decide on the event model to use as soon as it creates watchers, and it	1110	decide on the event model to use as soon as it creates watchers, and it
1034	might chose the wrong one unless you load the correct one yourself.	1111	might choose the wrong one unless you load the correct one yourself.
1035		1112
1036	You can chose to use a pure-perl implementation by loading the	1113	You can chose to use a pure-perl implementation by loading the
1037	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1114	C<AnyEvent::Loop> module, which gives you similar behaviour
1038	everywhere, but letting AnyEvent chose the model is generally better.	1115	everywhere, but letting AnyEvent chose the model is generally better.
1039		1116
1040	=head2 MAINLOOP EMULATION	1117	=head2 MAINLOOP EMULATION
1041		1118
1042	Sometimes (often for short test scripts, or even standalone programs who	1119	Sometimes (often for short test scripts, or even standalone programs who
…		…
1055		1132
1056		1133
1057	=head1 OTHER MODULES	1134	=head1 OTHER MODULES
1058		1135
1059	The following is a non-exhaustive list of additional modules that use	1136	The following is a non-exhaustive list of additional modules that use
1060	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1137	AnyEvent as a client and can therefore be mixed easily with other
1061	modules and other event loops in the same program. Some of the modules	1138	AnyEvent modules and other event loops in the same program. Some of the
1062	come with AnyEvent, most are available via CPAN.	1139	modules come as part of AnyEvent, the others are available via CPAN (see
		1140	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1141	a longer non-exhaustive list), and the list is heavily biased towards
		1142	modules of the AnyEvent author himself :)
1063		1143
1064	=over 4	1144	=over 4
1065		1145
1066	=item L<AnyEvent::Util>	1146	=item L<AnyEvent::Util>
1067		1147
1068	Contains various utility functions that replace often-used but blocking	1148	Contains various utility functions that replace often-used blocking
1069	functions such as C<inet_aton> by event-/callback-based versions.	1149	functions such as C<inet_aton> with event/callback-based versions.
1070		1150
1071	=item L<AnyEvent::Socket>	1151	=item L<AnyEvent::Socket>
1072		1152
1073	Provides various utility functions for (internet protocol) sockets,	1153	Provides various utility functions for (internet protocol) sockets,
1074	addresses and name resolution. Also functions to create non-blocking tcp	1154	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1076		1156
1077	=item L<AnyEvent::Handle>	1157	=item L<AnyEvent::Handle>
1078		1158
1079	Provide read and write buffers, manages watchers for reads and writes,	1159	Provide read and write buffers, manages watchers for reads and writes,
1080	supports raw and formatted I/O, I/O queued and fully transparent and	1160	supports raw and formatted I/O, I/O queued and fully transparent and
1081	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1161	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1082		1162
1083	=item L<AnyEvent::DNS>	1163	=item L<AnyEvent::DNS>
1084		1164
1085	Provides rich asynchronous DNS resolver capabilities.	1165	Provides rich asynchronous DNS resolver capabilities.
1086		1166
		1167	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1168
		1169	Implement event-based interfaces to the protocols of the same name (for
		1170	the curious, IGS is the International Go Server and FCP is the Freenet
		1171	Client Protocol).
		1172
1087	=item L<AnyEvent::HTTP>	1173	=item L<AnyEvent::AIO>
1088		1174
1089	A simple-to-use HTTP library that is capable of making a lot of concurrent	1175	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1090	HTTP requests.	1176	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1177	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1178	file I/O, and much more.
		1179
		1180	=item L<AnyEvent::Filesys::Notify>
		1181
		1182	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1183	path changes (e.g. "watch this directory for new files", "watch this
		1184	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1185	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1186	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1187	fall back to blocking scans at regular intervals transparently on other
		1188	platforms, so it's about as portable as it gets.
		1189
		1190	(I haven't used it myself, but I haven't heard anybody complaining about
		1191	it yet).
		1192
		1193	=item L<AnyEvent::DBI>
		1194
		1195	Executes L<DBI> requests asynchronously in a proxy process for you,
		1196	notifying you in an event-based way when the operation is finished.
1091		1197
1092	=item L<AnyEvent::HTTPD>	1198	=item L<AnyEvent::HTTPD>
1093		1199
1094	Provides a simple web application server framework.	1200	A simple embedded webserver.
1095		1201
1096	=item L<AnyEvent::FastPing>	1202	=item L<AnyEvent::FastPing>
1097		1203
1098	The fastest ping in the west.	1204	The fastest ping in the west.
1099		1205
1100	=item L<AnyEvent::DBI>
1101
1102	Executes L<DBI> requests asynchronously in a proxy process.
1103
1104	=item L<AnyEvent::AIO>
1105
1106	Truly asynchronous I/O, should be in the toolbox of every event
1107	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1108	together.
1109
1110	=item L<AnyEvent::BDB>
1111
1112	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1113	L<BDB> and AnyEvent together.
1114
1115	=item L<AnyEvent::GPSD>
1116
1117	A non-blocking interface to gpsd, a daemon delivering GPS information.
1118
1119	=item L<AnyEvent::IRC>
1120
1121	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1122
1123	=item L<AnyEvent::XMPP>
1124
1125	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1126	Net::XMPP2>.
1127
1128	=item L<AnyEvent::IGS>
1129
1130	A non-blocking interface to the Internet Go Server protocol (used by
1131	L<App::IGS>).
1132
1133	=item L<Net::FCP>
1134
1135	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1136	of AnyEvent.
1137
1138	=item L<Event::ExecFlow>
1139
1140	High level API for event-based execution flow control.
1141
1142	=item L<Coro>	1206	=item L<Coro>
1143		1207
1144	Has special support for AnyEvent via L<Coro::AnyEvent>.	1208	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1209	to simply invert the flow control - don't call us, we will call you:
		1210
		1211	async {
		1212	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1213	print "5 seconds later!\n";
		1214
		1215	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1216	my $line = <STDIN>; # works for ttys
		1217
		1218	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1219	my ($body, $hdr) = Coro::rouse_wait;
		1220	};
1145		1221
1146	=back	1222	=back
1147		1223
1148	=cut	1224	=cut
1149		1225
1150	package AnyEvent;	1226	package AnyEvent;
1151		1227
1152	# basically a tuned-down version of common::sense	1228	# basically a tuned-down version of common::sense
1153	sub common_sense {	1229	sub common_sense {
1154	# from common:.sense 1.0	1230	# from common:.sense 3.4
1155	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1231	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1156	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)	1232	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1157	$^H |= 0x00000600;	1233	$^H |= 0x00000600;
1158	}	1234	}
1159		1235
1160	BEGIN { AnyEvent::common_sense }	1236	BEGIN { AnyEvent::common_sense }
1161		1237
1162	use Carp ();	1238	use Carp ();
1163		1239
1164	our $VERSION = '5.26';	1240	our $VERSION = '6.02';
1165	our $MODEL;	1241	our $MODEL;
1166
1167	our $AUTOLOAD;
1168	our @ISA;	1242	our @ISA;
1169
1170	our @REGISTRY;	1243	our @REGISTRY;
1171
1172	our $VERBOSE;	1244	our $VERBOSE;
		1245	our $MAX_SIGNAL_LATENCY = 10;
		1246	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1173		1247
1174	BEGIN {	1248	BEGIN {
1175	require "AnyEvent/constants.pl";	1249	require "AnyEvent/constants.pl";
1176		1250
1177	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1251	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1178		1252
1179	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1253	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1180	if ${^TAINT};	1254	if ${^TAINT};
1181		1255
1182	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1256	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1257	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1183		1258
1184	}	1259	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1260	if ${^TAINT};
1185		1261
1186	our $MAX_SIGNAL_LATENCY = 10;	1262	# $ENV{PERL_ANYEVENT_xxx} now valid
1187		1263
1188	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1264	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1189		1265
1190	{
1191	my $idx;	1266	my $idx;
1192	$PROTOCOL{$_} = ++$idx	1267	$PROTOCOL{$_} = ++$idx
1193	for reverse split /\s*,\s*/,	1268	for reverse split /\s*,\s*/,
1194	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1269	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1195	}	1270	}
1196		1271
		1272	our @post_detect;
		1273
		1274	sub post_detect(&) {
		1275	my ($cb) = @_;
		1276
		1277	push @post_detect, $cb;
		1278
		1279	defined wantarray
		1280	? bless \$cb, "AnyEvent::Util::postdetect"
		1281	: ()
		1282	}
		1283
		1284	sub AnyEvent::Util::postdetect::DESTROY {
		1285	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1286	}
		1287
		1288	our $POSTPONE_W;
		1289	our @POSTPONE;
		1290
		1291	sub _postpone_exec {
		1292	undef $POSTPONE_W;
		1293
		1294	&{ shift @POSTPONE }
		1295	while @POSTPONE;
		1296	}
		1297
		1298	sub postpone(&) {
		1299	push @POSTPONE, shift;
		1300
		1301	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1302
		1303	()
		1304	}
		1305
		1306	sub log($$;@) {
		1307	# only load the big bloated module when we actually are about to log something
		1308	if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
		1309	require AnyEvent::Log;
		1310	# AnyEvent::Log overwrites this function
		1311	goto &log;
		1312	}
		1313
		1314	0 # not logged
		1315	}
		1316
		1317	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1318	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1319	}
		1320
1197	my @models = (	1321	our @models = (
1198	[EV:: => AnyEvent::Impl::EV:: , 1],	1322	[EV:: => AnyEvent::Impl::EV:: , 1],
1199	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1323	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1200	# everything below here will not (normally) be autoprobed	1324	# everything below here will not (normally) be autoprobed
1201	# as the pureperl backend should work everywhere	1325	# as the pure perl backend should work everywhere
1202	# and is usually faster	1326	# and is usually faster
1203	[Event:: => AnyEvent::Impl::Event::, 1],	1327	[Event:: => AnyEvent::Impl::Event::, 1],
1204	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1328	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1205	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1329	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1206	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1330	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1207	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1331	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1208	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1332	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1209	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1333	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1210	[Wx:: => AnyEvent::Impl::POE::],	1334	[Wx:: => AnyEvent::Impl::POE::],
1211	[Prima:: => AnyEvent::Impl::POE::],	1335	[Prima:: => AnyEvent::Impl::POE::],
1212	# IO::Async is just too broken - we would need workarounds for its	1336	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1213	# byzantine signal and broken child handling, among others.	1337	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1214	# IO::Async is rather hard to detect, as it doesn't have any	1338	[FLTK:: => AnyEvent::Impl::FLTK::],
1215	# obvious default class.
1216	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1217	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1218	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1219	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1220	);	1339	);
1221		1340
1222	our %method = map +($_ => 1),	1341	our @isa_hook;
		1342
		1343	sub _isa_set {
		1344	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1345
		1346	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1347	for 1 .. $#pkg;
		1348
		1349	grep $_ && $_->[1], @isa_hook
		1350	and AE::_reset ();
		1351	}
		1352
		1353	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1354	sub _isa_hook($$;$) {
		1355	my ($i, $pkg, $reset_ae) = @_;
		1356
		1357	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1358
		1359	_isa_set;
		1360	}
		1361
		1362	# all autoloaded methods reserve the complete glob, not just the method slot.
		1363	# due to bugs in perls method cache implementation.
1223	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1364	our @methods = qw(io timer time now now_update signal child idle condvar);
1224
1225	our @post_detect;
1226
1227	sub post_detect(&) {
1228	my ($cb) = @_;
1229
1230	push @post_detect, $cb;
1231
1232	defined wantarray
1233	? bless \$cb, "AnyEvent::Util::postdetect"
1234	: ()
1235	}
1236
1237	sub AnyEvent::Util::postdetect::DESTROY {
1238	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1239	}
1240		1365
1241	sub detect() {	1366	sub detect() {
		1367	return $MODEL if $MODEL; # some programs keep references to detect
		1368
		1369	local $!; # for good measure
		1370	local $SIG{__DIE__}; # we use eval
		1371
1242	# free some memory	1372	# free some memory
1243	*detect = sub () { $MODEL };	1373	*detect = sub () { $MODEL };
		1374	# undef &func doesn't correctly update the method cache. grmbl.
		1375	# so we delete the whole glob. grmbl.
		1376	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1377	# a glob with an active sub. hrm. i hope it works, but perl is
		1378	# usually buggy in this department. sigh.
		1379	delete @{"AnyEvent::"}{@methods};
		1380	undef @methods;
1244		1381
1245	local $!; # for good measure
1246	local $SIG{__DIE__};
1247
1248	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1382	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1249	my $model = "AnyEvent::Impl::$1";	1383	my $model = $1;
		1384	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1250	if (eval "require $model") {	1385	if (eval "require $model") {
		1386	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1251	$MODEL = $model;	1387	$MODEL = $model;
1252	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1253	} else {	1388	} else {
1254	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1389	AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1255	}	1390	}
1256	}	1391	}
1257		1392
1258	# check for already loaded models	1393	# check for already loaded models
1259	unless ($MODEL) {	1394	unless ($MODEL) {
1260	for (@REGISTRY, @models) {	1395	for (@REGISTRY, @models) {
1261	my ($package, $model) = @$_;	1396	my ($package, $model) = @$_;
1262	if (${"$package\::VERSION"} > 0) {	1397	if (${"$package\::VERSION"} > 0) {
1263	if (eval "require $model") {	1398	if (eval "require $model") {
		1399	AnyEvent::log 7 => "autodetected model '$model', using it.";
1264	$MODEL = $model;	1400	$MODEL = $model;
1265	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1266	last;	1401	last;
1267	}	1402	}
1268	}	1403	}
1269	}	1404	}
1270		1405
…		…
1276	$autoload	1411	$autoload
1277	and eval "require $package"	1412	and eval "require $package"
1278	and ${"$package\::VERSION"} > 0	1413	and ${"$package\::VERSION"} > 0
1279	and eval "require $model"	1414	and eval "require $model"
1280	) {	1415	) {
		1416	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1281	$MODEL = $model;	1417	$MODEL = $model;
1282	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1283	last;	1418	last;
1284	}	1419	}
1285	}	1420	}
1286		1421
1287	$MODEL	1422	$MODEL
1288	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1423	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1289	}	1424	}
1290	}	1425	}
1291		1426
1292	@models = (); # free probe data	1427	# free memory only needed for probing
		1428	undef @models;
		1429	undef @REGISTRY;
1293		1430
1294	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1431	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1295	unshift @ISA, $MODEL;
1296		1432
1297	# now nuke some methods that are overriden by the backend.	1433	# now nuke some methods that are overridden by the backend.
1298	# SUPER is not allowed.	1434	# SUPER usage is not allowed in these.
1299	for (qw(time signal child idle)) {	1435	for (qw(time signal child idle)) {
1300	undef &{"AnyEvent::Base::$_"}	1436	undef &{"AnyEvent::Base::$_"}
1301	if defined &{"$MODEL\::$_"};	1437	if defined &{"$MODEL\::$_"};
1302	}	1438	}
1303		1439
1304	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1440	_isa_set;
		1441
		1442	# we're officially open!
		1443
		1444	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1445	require AnyEvent::Strict;
		1446	}
		1447
		1448	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1449	require AnyEvent::Debug;
		1450	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1451	}
		1452
		1453	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1454	require AnyEvent::Socket;
		1455	require AnyEvent::Debug;
		1456
		1457	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1458	$shell =~ s/\$\$/$$/g;
		1459
		1460	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1461	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1462	}
		1463
		1464	# now the anyevent environment is set up as the user told us to, so
		1465	# call the actual user code - post detects
1305		1466
1306	(shift @post_detect)->() while @post_detect;	1467	(shift @post_detect)->() while @post_detect;
		1468	undef @post_detect;
1307		1469
1308	*post_detect = sub(&) {	1470	*post_detect = sub(&) {
1309	shift->();	1471	shift->();
1310		1472
1311	undef	1473	undef
1312	};	1474	};
1313		1475
1314	$MODEL	1476	$MODEL
1315	}	1477	}
1316		1478
1317	sub AUTOLOAD {	1479	for my $name (@methods) {
1318	(my $func = $AUTOLOAD) =~ s/.*://;	1480	*$name = sub {
1319
1320	$method{$func}
1321	or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323	detect;	1481	detect;
1324		1482	# we use goto because
1325	my $class = shift;	1483	# a) it makes the thunk more transparent
1326	$class->$func (@_);	1484	# b) it allows us to delete the thunk later
		1485	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1486	};
1327	}	1487	}
1328		1488
1329	# utility function to dup a filehandle. this is used by many backends	1489	# utility function to dup a filehandle. this is used by many backends
1330	# to support binding more than one watcher per filehandle (they usually	1490	# 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).	1491	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1355		1515
1356	package AE;	1516	package AE;
1357		1517
1358	our $VERSION = $AnyEvent::VERSION;	1518	our $VERSION = $AnyEvent::VERSION;
1359		1519
		1520	sub _reset() {
		1521	eval q{
1360	# fall back to the main API by default - backends and AnyEvent::Base	1522	# fall back to the main API by default - backends and AnyEvent::Base
1361	# implementations can overwrite these.	1523	# implementations can overwrite these.
1362		1524
1363	sub io($$$) {	1525	sub io($$$) {
1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1526	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365	}	1527	}
1366		1528
1367	sub timer($$$) {	1529	sub timer($$$) {
1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1530	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369	}	1531	}
1370		1532
1371	sub signal($$) {	1533	sub signal($$) {
1372	AnyEvent->signal (signal => $_[0], cb => $_[1])	1534	AnyEvent->signal (signal => $_[0], cb => $_[1])
1373	}	1535	}
1374		1536
1375	sub child($$) {	1537	sub child($$) {
1376	AnyEvent->child (pid => $_[0], cb => $_[1])	1538	AnyEvent->child (pid => $_[0], cb => $_[1])
1377	}	1539	}
1378		1540
1379	sub idle($) {	1541	sub idle($) {
1380	AnyEvent->idle (cb => $_[0])	1542	AnyEvent->idle (cb => $_[0]);
1381	}	1543	}
1382		1544
1383	sub cv(;&) {	1545	sub cv(;&) {
1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1546	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385	}	1547	}
1386		1548
1387	sub now() {	1549	sub now() {
1388	AnyEvent->now	1550	AnyEvent->now
1389	}	1551	}
1390		1552
1391	sub now_update() {	1553	sub now_update() {
1392	AnyEvent->now_update	1554	AnyEvent->now_update
1393	}	1555	}
1394		1556
1395	sub time() {	1557	sub time() {
1396	AnyEvent->time	1558	AnyEvent->time
		1559	}
		1560
		1561	*postpone = \&AnyEvent::postpone;
		1562	*log = \&AnyEvent::log;
		1563	};
		1564	die if $@;
1397	}	1565	}
		1566
		1567	BEGIN { _reset }
1398		1568
1399	package AnyEvent::Base;	1569	package AnyEvent::Base;
1400		1570
1401	# default implementations for many methods	1571	# default implementations for many methods
1402		1572
1403	sub time {	1573	sub time {
1404	eval q{ # poor man's autoloading {}	1574	eval q{ # poor man's autoloading {}
1405	# probe for availability of Time::HiRes	1575	# probe for availability of Time::HiRes
1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1576	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1577	*time = sub { Time::HiRes::time () };
1408	*AE::time = \&Time::HiRes::time;	1578	*AE::time = \& Time::HiRes::time ;
		1579	*now = \&time;
		1580	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1409	# if (eval "use POSIX (); (POSIX::times())...	1581	# if (eval "use POSIX (); (POSIX::times())...
1410	} else {	1582	} else {
		1583	*time = sub { CORE::time };
		1584	*AE::time = sub (){ CORE::time };
		1585	*now = \&time;
1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1586	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1412	*AE::time = sub (){ time }; # epic fail
1413	}	1587	}
1414
1415	*time = sub { AE::time }; # different prototypes
1416	};	1588	};
1417	die if $@;	1589	die if $@;
1418		1590
1419	&time	1591	&time
1420	}	1592	}
1421		1593
1422	*now = \&time;	1594	*now = \&time;
1423
1424	sub now_update { }	1595	sub now_update { }
1425		1596
		1597	sub _poll {
		1598	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1599	}
		1600
1426	# default implementation for ->condvar	1601	# default implementation for ->condvar
		1602	# in fact, the default should not be overwritten
1427		1603
1428	sub condvar {	1604	sub condvar {
1429	eval q{ # poor man's autoloading {}	1605	eval q{ # poor man's autoloading {}
1430	*condvar = sub {	1606	*condvar = sub {
1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1607	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1509		1685
1510	sub signal {	1686	sub signal {
1511	eval q{ # poor man's autoloading {}	1687	eval q{ # poor man's autoloading {}
1512	# probe for availability of Async::Interrupt	1688	# probe for availability of Async::Interrupt
1513	if (_have_async_interrupt) {	1689	if (_have_async_interrupt) {
1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1690	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1515		1691
1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1692	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1693	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1518		1694
1519	} else {	1695	} else {
1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1696	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1521		1697
1522	if (AnyEvent::WIN32) {	1698	if (AnyEvent::WIN32) {
1523	require AnyEvent::Util;	1699	require AnyEvent::Util;
1524		1700
1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1701	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1601	: sysread $SIGPIPE_R, (my $dummy), 9;	1777	: sysread $SIGPIPE_R, (my $dummy), 9;
1602		1778
1603	while (%SIG_EV) {	1779	while (%SIG_EV) {
1604	for (keys %SIG_EV) {	1780	for (keys %SIG_EV) {
1605	delete $SIG_EV{$_};	1781	delete $SIG_EV{$_};
1606	$_->() for values %{ $SIG_CB{$_} || {} };	1782	&$_ for values %{ $SIG_CB{$_} || {} };
1607	}	1783	}
1608	}	1784	}
1609	};	1785	};
1610	};	1786	};
1611	die if $@;	1787	die if $@;
…		…
1616	# default implementation for ->child	1792	# default implementation for ->child
1617		1793
1618	our %PID_CB;	1794	our %PID_CB;
1619	our $CHLD_W;	1795	our $CHLD_W;
1620	our $CHLD_DELAY_W;	1796	our $CHLD_DELAY_W;
1621	our $WNOHANG;
1622		1797
1623	# used by many Impl's	1798	# used by many Impl's
1624	sub _emit_childstatus($$) {	1799	sub _emit_childstatus($$) {
1625	my (undef, $rpid, $rstatus) = @_;	1800	my (undef, $rpid, $rstatus) = @_;
1626		1801
…		…
1633	eval q{ # poor man's autoloading {}	1808	eval q{ # poor man's autoloading {}
1634	*_sigchld = sub {	1809	*_sigchld = sub {
1635	my $pid;	1810	my $pid;
1636		1811
1637	AnyEvent->_emit_childstatus ($pid, $?)	1812	AnyEvent->_emit_childstatus ($pid, $?)
1638	while ($pid = waitpid -1, $WNOHANG) > 0;	1813	while ($pid = waitpid -1, WNOHANG) > 0;
1639	};	1814	};
1640		1815
1641	*child = sub {	1816	*child = sub {
1642	my (undef, %arg) = @_;	1817	my (undef, %arg) = @_;
1643		1818
1644	defined (my $pid = $arg{pid} + 0)	1819	my $pid = $arg{pid};
1645	or Carp::croak "required option 'pid' is missing";	1820	my $cb = $arg{cb};
1646		1821
1647	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1822	$PID_CB{$pid}{$cb+0} = $cb;
1648
1649	# WNOHANG is almost cetrainly 1 everywhere
1650	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1651	? 1
1652	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1653		1823
1654	unless ($CHLD_W) {	1824	unless ($CHLD_W) {
1655	$CHLD_W = AE::signal CHLD => \&_sigchld;	1825	$CHLD_W = AE::signal CHLD => \&_sigchld;
1656	# child could be a zombie already, so make at least one round	1826	# child could be a zombie already, so make at least one round
1657	&_sigchld;	1827	&_sigchld;
1658	}	1828	}
1659		1829
1660	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1830	bless [$pid, $cb+0], "AnyEvent::Base::child"
1661	};	1831	};
1662		1832
1663	*AnyEvent::Base::child::DESTROY = sub {	1833	*AnyEvent::Base::child::DESTROY = sub {
1664	my ($pid, $cb) = @{$_[0]};	1834	my ($pid, $icb) = @{$_[0]};
1665		1835
1666	delete $PID_CB{$pid}{$cb};	1836	delete $PID_CB{$pid}{$icb};
1667	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1837	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1668		1838
1669	undef $CHLD_W unless keys %PID_CB;	1839	undef $CHLD_W unless keys %PID_CB;
1670	};	1840	};
1671	};	1841	};
…		…
1684		1854
1685	my ($cb, $w, $rcb) = $arg{cb};	1855	my ($cb, $w, $rcb) = $arg{cb};
1686		1856
1687	$rcb = sub {	1857	$rcb = sub {
1688	if ($cb) {	1858	if ($cb) {
1689	$w = _time;	1859	$w = AE::time;
1690	&$cb;	1860	&$cb;
1691	$w = _time - $w;	1861	$w = AE::time - $w;
1692		1862
1693	# never use more then 50% of the time for the idle watcher,	1863	# never use more then 50% of the time for the idle watcher,
1694	# within some limits	1864	# within some limits
1695	$w = 0.0001 if $w < 0.0001;	1865	$w = 0.0001 if $w < 0.0001;
1696	$w = 5 if $w > 5;	1866	$w = 5 if $w > 5;
…		…
1719		1889
1720	package AnyEvent::CondVar;	1890	package AnyEvent::CondVar;
1721		1891
1722	our @ISA = AnyEvent::CondVar::Base::;	1892	our @ISA = AnyEvent::CondVar::Base::;
1723		1893
		1894	# only to be used for subclassing
		1895	sub new {
		1896	my $class = shift;
		1897	bless AnyEvent->condvar (@_), $class
		1898	}
		1899
1724	package AnyEvent::CondVar::Base;	1900	package AnyEvent::CondVar::Base;
1725		1901
1726	#use overload	1902	#use overload
1727	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1903	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1728	# fallback => 1;	1904	# fallback => 1;
…		…
1737		1913
1738	sub _send {	1914	sub _send {
1739	# nop	1915	# nop
1740	}	1916	}
1741		1917
		1918	sub _wait {
		1919	AnyEvent->_poll until $_[0]{_ae_sent};
		1920	}
		1921
1742	sub send {	1922	sub send {
1743	my $cv = shift;	1923	my $cv = shift;
1744	$cv->{_ae_sent} = [@_];	1924	$cv->{_ae_sent} = [@_];
1745	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1925	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746	$cv->_send;	1926	$cv->_send;
…		…
1753		1933
1754	sub ready {	1934	sub ready {
1755	$_[0]{_ae_sent}	1935	$_[0]{_ae_sent}
1756	}	1936	}
1757		1937
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 {	1938	sub recv {
		1939	unless ($_[0]{_ae_sent}) {
		1940	$WAITING
		1941	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1942
		1943	local $WAITING = 1;
1768	$_[0]->_wait;	1944	$_[0]->_wait;
		1945	}
1769		1946
1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1947	$_[0]{_ae_croak}
1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1948	and Carp::croak $_[0]{_ae_croak};
		1949
		1950	wantarray
		1951	? @{ $_[0]{_ae_sent} }
		1952	: $_[0]{_ae_sent}[0]
1772	}	1953	}
1773		1954
1774	sub cb {	1955	sub cb {
1775	my $cv = shift;	1956	my $cv = shift;
1776		1957
…		…
1792	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1973	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1793	}	1974	}
1794		1975
1795	# undocumented/compatibility with pre-3.4	1976	# undocumented/compatibility with pre-3.4
1796	*broadcast = \&send;	1977	*broadcast = \&send;
1797	*wait = \&_wait;	1978	*wait = \&recv;
1798		1979
1799	=head1 ERROR AND EXCEPTION HANDLING	1980	=head1 ERROR AND EXCEPTION HANDLING
1800		1981
1801	In general, AnyEvent does not do any error handling - it relies on the	1982	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	1983	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	1995	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1815	so on.	1996	so on.
1816		1997
1817	=head1 ENVIRONMENT VARIABLES	1998	=head1 ENVIRONMENT VARIABLES
1818		1999
1819	The following environment variables are used by this module or its	2000	AnyEvent supports a number of environment variables that tune the
1820	submodules.	2001	runtime behaviour. They are usually evaluated when AnyEvent is
		2002	loaded, initialised, or a submodule that uses them is loaded. Many of
		2003	them also cause AnyEvent to load additional modules - for example,
		2004	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2005	loaded.
1821		2006
1822	Note that AnyEvent will remove I<all> environment variables starting with	2007	All the environment variables documented here start with
1823	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2008	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1824	enabled.	2009	namespace. Other modules are encouraged (but by no means required) to use
		2010	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2011	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2012	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2013	variables starting with C<AE_>, see below).
		2014
		2015	All variables can also be set via the C<AE_> prefix, that is, instead
		2016	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2017	case there is a clash btween anyevent and another program that uses
		2018	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2019	variable to the empty string, as those variables take precedence.
		2020
		2021	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2022	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2023	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2024	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2025	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2026	is set).
		2027
		2028	The exact algorithm is currently:
		2029
		2030	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2031	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2032	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2033
		2034	This ensures that child processes will not see the C<AE_> variables.
		2035
		2036	The following environment variables are currently known to AnyEvent:
1825		2037
1826	=over 4	2038	=over 4
1827		2039
1828	=item C<PERL_ANYEVENT_VERBOSE>	2040	=item C<PERL_ANYEVENT_VERBOSE>
1829		2041
1830	By default, AnyEvent will be completely silent except in fatal	2042	By default, AnyEvent will only log messages with loglevel C<3>
1831	conditions. You can set this environment variable to make AnyEvent more	2043	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2044	environment variable to a numerical loglevel to make AnyEvent more (or
1832	talkative.	2045	less) talkative.
1833		2046
		2047	If you want to do more than just set the global logging level
		2048	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2049	complex specifications.
		2050
		2051	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2052	the default logging settings.
		2053
1834	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2054	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	2055	unexpected conditions, such as not being able to load the event model
1836	C<PERL_ANYEVENT_MODEL>.	2056	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2057	exception - this is the minimum recommended level.
1837		2058
1838	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2059	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1839	model it chooses.	2060	chooses.
1840		2061
1841	When set to C<8> or higher, then AnyEvent will report extra information on	2062	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.	2063	which optional modules it loads and how it implements certain features.
		2064
		2065	=item C<PERL_ANYEVENT_LOG>
		2066
		2067	Accepts rather complex logging specifications. For example, you could log
		2068	all C<debug> messages of some module to stderr, warnings and above to
		2069	stderr, and errors and above to syslog, with:
		2070
		2071	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2072
		2073	For the rather extensive details, see L<AnyEvent::Log>.
		2074
		2075	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2076	so will take effect even before AnyEvent has initialised itself.
		2077
		2078	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2079	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2080	using the latter saves a few hundred kB of memory until the first message
		2081	is being logged.
1843		2082
1844	=item C<PERL_ANYEVENT_STRICT>	2083	=item C<PERL_ANYEVENT_STRICT>
1845		2084
1846	AnyEvent does not do much argument checking by default, as thorough	2085	AnyEvent does not do much argument checking by default, as thorough
1847	argument checking is very costly. Setting this variable to a true value	2086	argument checking is very costly. Setting this variable to a true value
…		…
1849	check the arguments passed to most method calls. If it finds any problems,	2088	check the arguments passed to most method calls. If it finds any problems,
1850	it will croak.	2089	it will croak.
1851		2090
1852	In other words, enables "strict" mode.	2091	In other words, enables "strict" mode.
1853		2092
1854	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	2093	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	2094	>>, it is definitely recommended to keep it off in production. Keeping
1856	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2095	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857	can be very useful, however.	2096	can be very useful, however.
1858		2097
		2098	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2099
		2100	If this env variable is nonempty, then its contents will be interpreted by
		2101	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2102	replacing every occurance of C<$$> by the process pid). The shell object
		2103	is saved in C<$AnyEvent::Debug::SHELL>.
		2104
		2105	This happens when the first watcher is created.
		2106
		2107	For example, to bind a debug shell on a unix domain socket in
		2108	F<< /tmp/debug<pid>.sock >>, you could use this:
		2109
		2110	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2111	# connect with e.g.: socat readline /tmp/debug123.sock
		2112
		2113	Or to bind to tcp port 4545 on localhost:
		2114
		2115	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2116	# connect with e.g.: telnet localhost 4545
		2117
		2118	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2119	multiuser systems.
		2120
		2121	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2122
		2123	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2124	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2125
1859	=item C<PERL_ANYEVENT_MODEL>	2126	=item C<PERL_ANYEVENT_MODEL>
1860		2127
1861	This can be used to specify the event model to be used by AnyEvent, before	2128	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	2129	auto detection and -probing kicks in.
1863	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2130
		2131	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2132	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,	2133	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	2134	event model backend. If it fails to load then AnyEvent will proceed with
1866	auto detection and -probing.	2135	auto detection and -probing.
1867		2136
1868	This functionality might change in future versions.	2137	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2138	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2139	the end of a string designates a module name and quotes it appropriately).
1869		2140
1870	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2141	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871	could start your program like this:	2142	could start your program like this:
1872		2143
1873	PERL_ANYEVENT_MODEL=Perl perl ...	2144	PERL_ANYEVENT_MODEL=Perl perl ...
1874		2145
1875	=item C<PERL_ANYEVENT_PROTOCOLS>	2146	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1891	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2162	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1892	- only support IPv4, never try to resolve or contact IPv6	2163	- only support IPv4, never try to resolve or contact IPv6
1893	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2164	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1894	IPv6, but prefer IPv6 over IPv4.	2165	IPv6, but prefer IPv6 over IPv4.
1895		2166
		2167	=item C<PERL_ANYEVENT_HOSTS>
		2168
		2169	This variable, if specified, overrides the F</etc/hosts> file used by
		2170	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2171	from that file instead.
		2172
1896	=item C<PERL_ANYEVENT_EDNS0>	2173	=item C<PERL_ANYEVENT_EDNS0>
1897		2174
1898	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2175	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	2176	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	2177	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1901	default.	2178	packets, which is why it is off by default.
1902		2179
1903	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2180	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1904	EDNS0 in its DNS requests.	2181	EDNS0 in its DNS requests.
1905		2182
1906	=item C<PERL_ANYEVENT_MAX_FORKS>	2183	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1914	resolver - this is the maximum number of parallel DNS requests that are	2191	resolver - this is the maximum number of parallel DNS requests that are
1915	sent to the DNS server.	2192	sent to the DNS server.
1916		2193
1917	=item C<PERL_ANYEVENT_RESOLV_CONF>	2194	=item C<PERL_ANYEVENT_RESOLV_CONF>
1918		2195
1919	The file to use instead of F</etc/resolv.conf> (or OS-specific	2196	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	2197	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1921	default config will be used.	2198	resolver, or the empty string to select the default configuration.
1922		2199
1923	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2200	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1924		2201
1925	When neither C<ca_file> nor C<ca_path> was specified during	2202	When neither C<ca_file> nor C<ca_path> was specified during
1926	L<AnyEvent::TLS> context creation, and either of these environment	2203	L<AnyEvent::TLS> context creation, and either of these environment
1927	variables exist, they will be used to specify CA certificate locations	2204	variables are nonempty, they will be used to specify CA certificate
1928	instead of a system-dependent default.	2205	locations instead of a system-dependent default.
1929		2206
1930	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2207	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1931		2208
1932	When these are set to C<1>, then the respective modules are not	2209	When these are set to C<1>, then the respective modules are not
1933	loaded. Mostly good for testing AnyEvent itself.	2210	loaded. Mostly good for testing AnyEvent itself.
…		…
2265	(even when used without AnyEvent), but most event loops have acceptable	2542	(even when used without AnyEvent), but most event loops have acceptable
2266	performance with or without AnyEvent.	2543	performance with or without AnyEvent.
2267		2544
2268	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2545	=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	2546	the actual event loop, only with extremely fast event loops such as EV
2270	adds AnyEvent significant overhead.	2547	does AnyEvent add significant overhead.
2271		2548
2272	=item * You should avoid POE like the plague if you want performance or	2549	=item * You should avoid POE like the plague if you want performance or
2273	reasonable memory usage.	2550	reasonable memory usage.
2274		2551
2275	=back	2552	=back
…		…
2505	unless defined $SIG{PIPE};	2782	unless defined $SIG{PIPE};
2506		2783
2507	=head1 RECOMMENDED/OPTIONAL MODULES	2784	=head1 RECOMMENDED/OPTIONAL MODULES
2508		2785
2509	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2786	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2510	it's built-in modules) are required to use it.	2787	its built-in modules) are required to use it.
2511		2788
2512	That does not mean that AnyEvent won't take advantage of some additional	2789	That does not mean that AnyEvent won't take advantage of some additional
2513	modules if they are installed.	2790	modules if they are installed.
2514		2791
2515	This section explains which additional modules will be used, and how they	2792	This section explains which additional modules will be used, and how they
…		…
2573	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2850	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2574		2851
2575	=item L<Time::HiRes>	2852	=item L<Time::HiRes>
2576		2853
2577	This module is part of perl since release 5.008. It will be used when the	2854	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 on it's own. The	2855	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	2856	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580	try to use a monotonic clock for timing stability.	2857	try to use a monotonic clock for timing stability.
2581		2858
2582	=back	2859	=back
2583		2860
2584		2861
…		…
2646	pronounced).	2923	pronounced).
2647		2924
2648		2925
2649	=head1 SEE ALSO	2926	=head1 SEE ALSO
2650		2927
2651	Utility functions: L<AnyEvent::Util>.	2928	Tutorial/Introduction: L<AnyEvent::Intro>.
2652		2929
2653	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2930	FAQ: L<AnyEvent::FAQ>.
2654	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2931
		2932	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2933	(simply logging).
		2934
		2935	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2936	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2937
		2938	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2939	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2940	L<Qt>, L<POE>, L<FLTK>.
2655		2941
2656	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2942	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2657	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2943	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2658	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2944	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2659	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2945	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2946	L<AnyEvent::Impl::FLTK>.
2660		2947
2661	Non-blocking file handles, sockets, TCP clients and	2948	Non-blocking handles, pipes, stream sockets, TCP clients and
2662	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2949	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2663		2950
2664	Asynchronous DNS: L<AnyEvent::DNS>.	2951	Asynchronous DNS: L<AnyEvent::DNS>.
2665		2952
2666	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2953	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2667	L<Coro::Event>,
2668		2954
2669	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2955	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2670	L<AnyEvent::HTTP>.	2956	L<AnyEvent::HTTP>.
2671		2957
2672		2958
2673	=head1 AUTHOR	2959	=head1 AUTHOR
2674		2960

Diff Legend

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