ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.311 by root, Wed Feb 10 13:33:44 2010 UTC vs.
Revision 1.384 by root, Mon Sep 5 07:21:54 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 AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18		21
19	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21		24
22	# POSIX signal	25	# POSIX signal
…		…
43	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
44	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
45		48
46	=head1 SUPPORT	49	=head1 SUPPORT
47		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
48	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
49	channel, too.	54	channel, too.
50		55
51	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
52	Repository>, at L<http://anyevent.schmorp.de>, for more info.	57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		58
…		…
73	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
74	model you use.	79	model you use.
75		80
76	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
77	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
78	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
79	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
80	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
81	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.
82		87
83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84	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
85	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
86	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
87	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
88	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
89	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,
90	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
91		96
92	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
93	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
94	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
95	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
96	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
97	technically possible.	102	technically possible.
98		103
99	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
100	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
106	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
107	model, you should I<not> use this module.	112	model, you should I<not> use this module.
108		113
109	=head1 DESCRIPTION	114	=head1 DESCRIPTION
110		115
111	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
112	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
113	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
114	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
115		120
116	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>
117	module.	122	module.
118		123
119	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
120	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
121	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
122	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
123	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
124	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
125	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
126	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
127	found, AnyEvent will fall back to a pure-perl event loop, which is not
128	very efficient, but should work everywhere.
129		132
130	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
131	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
132	that model the default. For example:	135	that model the default. For example:
133		136
…		…
135	use AnyEvent;	138	use AnyEvent;
136		139
137	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
138		141
139	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
140	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,
141	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
142		146
143	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
144	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
145	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
146		150
147	=head1 WATCHERS	151	=head1 WATCHERS
148		152
149	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
150	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
…		…
155	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
156	is in control).	160	is in control).
157		161
158	Note that B<callbacks must not permanently change global variables>	162	Note that B<callbacks must not permanently change global variables>
159	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<<
160	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
161	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
162	widely between event loops.	166	widely between event loops.
163		167
164	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
165	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
166	to it).	170	to it).
167		171
168	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.
169		173
170	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
171	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.
172		176
173	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
174		178
175	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
176	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
177	undef $w;	181	undef $w;
178	});	182	});
…		…
210		214
211	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.
212	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
213	underlying file descriptor.	217	underlying file descriptor.
214		218
215	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
216	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
217	handles.	221	handles.
218		222
219	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
220	watcher.	224	watcher.
…		…
244		248
245	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
246	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
247	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
248		252
249	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
250	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
251	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
252	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
253	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.
254		258
255	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
256	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
257	only approximate.	261	only approximate.
258		262
259	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
260		264
261	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
279		283
280	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
281	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
282	"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
283	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
284	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.
285		289
286	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
287	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
288	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)
289	timers.	293	timers.
290		294
291	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
292	AnyEvent API.	296	AnyEvent API.
…		…
314	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
315	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
316		320
317	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
318	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
319	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
320		324
321	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
322	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
323		327
324	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>
325	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
326		330
327	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
328	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
329	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
330	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
331	after three seconds.	335	after three seconds.
332		336
…		…
352	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
353	account.	357	account.
354		358
355	=item AnyEvent->now_update	359	=item AnyEvent->now_update
356		360
357	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
358	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 >>,
359	AnyEvent->now >>, above).	363	above).
360		364
361	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
362	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
363	might affect timers and time-outs.	367	might affect timers and time-outs.
364		368
…		…
425	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
426		430
427	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
428	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
429	do race-free signal handling in perl, requiring C libraries for	433	do race-free signal handling in perl, requiring C libraries for
430	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,
431	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
432	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
433	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,
434	and should be left alone otherwise. This variable determines how often	438	and should be left alone otherwise. This variable determines how often
435	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
…		…
437	saving.	441	saving.
438		442
439	All these problems can be avoided by installing the optional	443	All these problems can be avoided by installing the optional
440	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
441	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>
442	(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
443	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.
444		448
445	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
446		450
447	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
448		452
449	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.
450		454
451	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,
452	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
453	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
454	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
455	(stopped/continued).	459	(stopped/continued).
456		460
…		…
478	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
479	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
480	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
481		485
482	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
483	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
484	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
485		489
486	Example: fork a process and wait for it	490	Example: fork a process and wait for it
487		491
488	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
489		493
…		…
503		507
504	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
505		509
506	$w = AnyEvent->idle (cb => <callback>);	510	$w = AnyEvent->idle (cb => <callback>);
507		511
508	Repeatedly invoke the callback after the process becomes idle, until	512	This will repeatedly invoke the callback after the process becomes idle,
509	either the watcher is destroyed or new events have been detected.	513	until either the watcher is destroyed or new events have been detected.
510		514
511	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
512	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
513	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
514	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
…		…
553	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
554		558
555	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
556	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).
557		561
558	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
559	because they represent a condition that must become true.	563	they represent a condition that must become true.
560		564
561	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.
562		566
563	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
564	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
…		…
569	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
570	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
571	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<<
572	->send >> method).	576	->send >> method).
573		577
574	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
575	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:
576	in time where multiple outstanding events have been processed. And yet	580
577	another way to call them is transactions - each condition variable can be	581	=over 4
578	used to represent a transaction, which finishes at some point and delivers	582
579	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
580	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
581		601
582	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
583	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,
584	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
585	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
…		…
598		618
599	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
600	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
601	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
602	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
603	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
604		624
605	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
606	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
607	for the send to occur.	627	for the send to occur.
608		628
609	Example: wait for a timer.	629	Example: wait for a timer.
610		630
611	# wait till the result is ready	631	# condition: "wait till the timer is fired"
612	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
613		633
614	# do something such as adding a timer	634	# create the timer - we could wait for, say
615	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
616	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
617	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
618	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
619	after => 1,	639	after => 1,
620	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
621	);	641	);
622		642
623	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
624	# calls ->send	644	# calls ->send
625	$result_ready->recv;	645	$timer_fired->recv;
626		646
627	Example: wait for a timer, but take advantage of the fact that condition	647	Example: wait for a timer, but take advantage of the fact that condition
628	variables are also callable directly.	648	variables are also callable directly.
629		649
630	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
…		…
673	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
674	C<send>.	694	C<send>.
675		695
676	=item $cv->croak ($error)	696	=item $cv->croak ($error)
677		697
678	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
679	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
680		700
681	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
682	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
683	delays the error detetcion, but has the overwhelmign advantage that it	703	delays the error detection, but has the overwhelming advantage that it
684	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
685	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
686	the problem.	706	the problem.
687		707
688	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
689		709
690	=item $cv->end	710	=item $cv->end
…		…
728	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
729	sending.	749	sending.
730		750
731	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
732	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
733	begung can potentially be zero:	753	begun can potentially be zero:
734		754
735	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
736		756
737	my %result;	757	my %result;
738	$cv->begin (sub { shift->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
…		…
759	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
760	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
761	doesn't execute once).	781	doesn't execute once).
762		782
763	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
764	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
765	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
766	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,
767	call C<end>.	787	call C<end>.
768		788
769	=back	789	=back
…		…
776	=over 4	796	=over 4
777		797
778	=item $cv->recv	798	=item $cv->recv
779		799
780	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
781	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
782	normally.	802	normally.
783		803
784	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
785	will return immediately.	805	will return immediately.
786		806
…		…
803	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
804	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
805	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,
806	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
807		827
808	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
809	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
810	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
811	waits otherwise.	831	waits otherwise.
812		832
813	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
818	=item $cb = $cv->cb ($cb->($cv))	838	=item $cb = $cv->cb ($cb->($cv))
819		839
820	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
821	replaces it before doing so.	841	replaces it before doing so.
822		842
823	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
824	"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
825	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
826	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.
827		848
828	=back	849	=back
829		850
830	=head1 SUPPORTED EVENT LOOPS/BACKENDS	851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
831		852
…		…
839	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
840	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
841	AnyEvent itself.	862	AnyEvent itself.
842		863
843	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
844	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
845		866
846	=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.
847		868
848	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
849	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
850	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
851	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
852	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.
853		874
…		…
855	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
856	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
857	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
858	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
859	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).
860		884
861	=item Backends with special needs.	885	=item Backends with special needs.
862		886
863	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
864	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
865	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
866	everything should just work.	890	everything should just work.
867		891
868	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
869		893
870	Support for IO::Async can only be partial, as it is too broken and
871	architecturally limited to even support the AnyEvent API. It also
872	is the only event loop that needs the loop to be set explicitly, so
873	it can only be used by a main program knowing about AnyEvent. See
874	L<AnyEvent::Impl::Async> for the gory details.
875
876	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
877
878	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
879		895
880	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
881		897
882	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>.
…		…
907	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
908	backend has been autodetected.	924	backend has been autodetected.
909		925
910	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
911	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
912	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
913	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
914	will be C<urxvt::anyevent>).	930	will be C<urxvt::anyevent>).
915		931
916	=item AnyEvent::detect	932	=item AnyEvent::detect
917		933
918	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
919	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
920	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
921	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).
922		942
923	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
924	created, use C<post_detect>.	944	created, use C<post_detect>.
925		945
926	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
927		947
928	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
929	autodetected (or immediately if this has already happened).	949	autodetected (or immediately if that has already happened).
930		950
931	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
932	(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
933	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
934	other initialisations - see the sources of L<AnyEvent::Strict> or	954	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
943	that automatically removes the callback again when it is destroyed (or	963	that automatically removes the callback again when it is destroyed (or
944	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
945	a case where this is useful.	965	a case where this is useful.
946		966
947	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
948	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.
949		969
950	our WATCHER;	970	our WATCHER;
951		971
952	my $guard = AnyEvent::post_detect {	972	my $guard = AnyEvent::post_detect {
953	$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);
…		…
961	$WATCHER ||= $guard;	981	$WATCHER ||= $guard;
962		982
963	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
964		984
965	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
966	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will be called directly
967	the event loop has been chosen.	987	after the event loop has been chosen.
968		988
969	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:
970	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
971	array will be ignored.	991	array will be ignored.
972		992
…		…
989	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
990	# as soon as it is	1010	# as soon as it is
991	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
992	}	1012	}
993		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
994	=back	1072	=back
995		1073
996	=head1 WHAT TO DO IN A MODULE	1074	=head1 WHAT TO DO IN A MODULE
997		1075
998	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
…		…
1008	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
1009	events is to stay interactive.	1087	events is to stay interactive.
1010		1088
1011	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
1012	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
1013	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 >>
1014	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).
1015		1093
1016	=head1 WHAT TO DO IN THE MAIN PROGRAM	1094	=head1 WHAT TO DO IN THE MAIN PROGRAM
1017		1095
1018	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
1019	dictate which event model to use.	1097	dictate which event model to use.
1020		1098
1021	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
1022	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
1023	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.
1024		1104
1025	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
1026	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
1027	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
1028	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
1029	modules might create watchers when they are loaded, and AnyEvent will	1109	modules might create watchers when they are loaded, and AnyEvent will
1030	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
1031	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.
1032		1112
1033	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
1034	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1114	C<AnyEvent::Loop> module, which gives you similar behaviour
1035	everywhere, but letting AnyEvent chose the model is generally better.	1115	everywhere, but letting AnyEvent chose the model is generally better.
1036		1116
1037	=head2 MAINLOOP EMULATION	1117	=head2 MAINLOOP EMULATION
1038		1118
1039	Sometimes (often for short test scripts, or even standalone programs who	1119	Sometimes (often for short test scripts, or even standalone programs who
…		…
1052		1132
1053		1133
1054	=head1 OTHER MODULES	1134	=head1 OTHER MODULES
1055		1135
1056	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
1057	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
1058	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
1059	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 :)
1060		1143
1061	=over 4	1144	=over 4
1062		1145
1063	=item L<AnyEvent::Util>	1146	=item L<AnyEvent::Util>
1064		1147
1065	Contains various utility functions that replace often-used but blocking	1148	Contains various utility functions that replace often-used blocking
1066	functions such as C<inet_aton> by event-/callback-based versions.	1149	functions such as C<inet_aton> with event/callback-based versions.
1067		1150
1068	=item L<AnyEvent::Socket>	1151	=item L<AnyEvent::Socket>
1069		1152
1070	Provides various utility functions for (internet protocol) sockets,	1153	Provides various utility functions for (internet protocol) sockets,
1071	addresses and name resolution. Also functions to create non-blocking tcp	1154	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1073		1156
1074	=item L<AnyEvent::Handle>	1157	=item L<AnyEvent::Handle>
1075		1158
1076	Provide read and write buffers, manages watchers for reads and writes,	1159	Provide read and write buffers, manages watchers for reads and writes,
1077	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
1078	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1161	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1079		1162
1080	=item L<AnyEvent::DNS>	1163	=item L<AnyEvent::DNS>
1081		1164
1082	Provides rich asynchronous DNS resolver capabilities.	1165	Provides rich asynchronous DNS resolver capabilities.
1083		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
1084	=item L<AnyEvent::HTTP>	1173	=item L<AnyEvent::AIO>
1085		1174
1086	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
1087	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.
1088		1197
1089	=item L<AnyEvent::HTTPD>	1198	=item L<AnyEvent::HTTPD>
1090		1199
1091	Provides a simple web application server framework.	1200	A simple embedded webserver.
1092		1201
1093	=item L<AnyEvent::FastPing>	1202	=item L<AnyEvent::FastPing>
1094		1203
1095	The fastest ping in the west.	1204	The fastest ping in the west.
1096		1205
1097	=item L<AnyEvent::DBI>
1098
1099	Executes L<DBI> requests asynchronously in a proxy process.
1100
1101	=item L<AnyEvent::AIO>
1102
1103	Truly asynchronous I/O, should be in the toolbox of every event
1104	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1105	together.
1106
1107	=item L<AnyEvent::BDB>
1108
1109	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1110	L<BDB> and AnyEvent together.
1111
1112	=item L<AnyEvent::GPSD>
1113
1114	A non-blocking interface to gpsd, a daemon delivering GPS information.
1115
1116	=item L<AnyEvent::IRC>
1117
1118	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1119
1120	=item L<AnyEvent::XMPP>
1121
1122	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1123	Net::XMPP2>.
1124
1125	=item L<AnyEvent::IGS>
1126
1127	A non-blocking interface to the Internet Go Server protocol (used by
1128	L<App::IGS>).
1129
1130	=item L<Net::FCP>
1131
1132	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1133	of AnyEvent.
1134
1135	=item L<Event::ExecFlow>
1136
1137	High level API for event-based execution flow control.
1138
1139	=item L<Coro>	1206	=item L<Coro>
1140		1207
1141	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	};
1142		1221
1143	=back	1222	=back
1144		1223
1145	=cut	1224	=cut
1146		1225
1147	package AnyEvent;	1226	package AnyEvent;
1148		1227
1149	# basically a tuned-down version of common::sense	1228	# basically a tuned-down version of common::sense
1150	sub common_sense {	1229	sub common_sense {
1151	# from common:.sense 1.0	1230	# from common:.sense 3.4
1152	${^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";
1153	# 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)
1154	$^H |= 0x00000600;	1233	$^H |= 0x00000600;
1155	}	1234	}
1156		1235
1157	BEGIN { AnyEvent::common_sense }	1236	BEGIN { AnyEvent::common_sense }
1158		1237
1159	use Carp ();	1238	use Carp ();
1160		1239
1161	our $VERSION = '5.24';	1240	our $VERSION = '6.02';
1162	our $MODEL;	1241	our $MODEL;
1163
1164	our $AUTOLOAD;
1165	our @ISA;	1242	our @ISA;
1166
1167	our @REGISTRY;	1243	our @REGISTRY;
1168
1169	our $VERBOSE;	1244	our $VERBOSE;
		1245	our $MAX_SIGNAL_LATENCY = 10;
		1246	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1170		1247
1171	BEGIN {	1248	BEGIN {
1172	eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";	1249	require "AnyEvent/constants.pl";
1173	eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";	1250
1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";	1251	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1175		1252
1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1253	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1177	if ${^TAINT};	1254	if ${^TAINT};
1178		1255
1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1256	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1257	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1180		1258
1181	}	1259	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1260	if ${^TAINT};
1182		1261
1183	our $MAX_SIGNAL_LATENCY = 10;	1262	# $ENV{PERL_ANYEVENT_xxx} now valid
1184		1263
1185	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1264	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1186		1265
1187	{
1188	my $idx;	1266	my $idx;
1189	$PROTOCOL{$_} = ++$idx	1267	$PROTOCOL{$_} = ++$idx
1190	for reverse split /\s*,\s*/,	1268	for reverse split /\s*,\s*/,
1191	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1269	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1192	}	1270	}
1193		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 || 1)) { # also catches non-numeric levels(!) and fatal
		1309	require AnyEvent::Log; # among other things, sets $VERBOSE to 9
		1310	# AnyEvent::Log overwrites this function
		1311	goto &log;
		1312	}
		1313
		1314	0 # not logged
		1315	}
		1316
		1317	sub logger($;$) {
		1318	package AnyEvent::Log;
		1319
		1320	my ($level, $renabled) = @_;
		1321
		1322	$$renabled = $level <= $VERBOSE;
		1323
		1324	my $pkg = (caller)[0];
		1325
		1326	my $logger = [$pkg, $level, $renabled];
		1327
		1328	our %LOGGER;
		1329	$LOGGER{$logger+0} = $logger;
		1330
		1331	require AnyEvent::Util;
		1332	my $guard = AnyEvent::Util::guard (sub {
		1333	# "clean up"
		1334	delete $LOGGER{$logger+0};
		1335	});
		1336
		1337	sub {
		1338	return 0 unless $$renabled;
		1339
		1340	$guard if 0; # keep guard alive, but don't cause runtime overhead
		1341	require AnyEvent::Log unless $AnyEvent::Log::VERSION;
		1342	package AnyEvent::Log;
		1343	_log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
		1344	}
		1345	}
		1346
		1347	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1348	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1349	}
		1350
1194	my @models = (	1351	our @models = (
1195	[EV:: => AnyEvent::Impl::EV:: , 1],	1352	[EV:: => AnyEvent::Impl::EV:: , 1],
1196	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1353	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1197	# everything below here will not (normally) be autoprobed	1354	# everything below here will not (normally) be autoprobed
1198	# as the pureperl backend should work everywhere	1355	# as the pure perl backend should work everywhere
1199	# and is usually faster	1356	# and is usually faster
1200	[Event:: => AnyEvent::Impl::Event::, 1],	1357	[Event:: => AnyEvent::Impl::Event::, 1],
1201	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1358	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1202	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1359	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1203	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1360	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1204	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1361	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1205	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1362	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1206	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1363	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1207	[Wx:: => AnyEvent::Impl::POE::],	1364	[Wx:: => AnyEvent::Impl::POE::],
1208	[Prima:: => AnyEvent::Impl::POE::],	1365	[Prima:: => AnyEvent::Impl::POE::],
1209	# IO::Async is just too broken - we would need workarounds for its	1366	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1210	# byzantine signal and broken child handling, among others.	1367	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1211	# IO::Async is rather hard to detect, as it doesn't have any	1368	[FLTK:: => AnyEvent::Impl::FLTK::],
1212	# obvious default class.
1213	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1215	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1216	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1217	);	1369	);
1218		1370
1219	our %method = map +($_ => 1),	1371	our @isa_hook;
		1372
		1373	sub _isa_set {
		1374	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1375
		1376	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1377	for 1 .. $#pkg;
		1378
		1379	grep $_ && $_->[1], @isa_hook
		1380	and AE::_reset ();
		1381	}
		1382
		1383	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1384	sub _isa_hook($$;$) {
		1385	my ($i, $pkg, $reset_ae) = @_;
		1386
		1387	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1388
		1389	_isa_set;
		1390	}
		1391
		1392	# all autoloaded methods reserve the complete glob, not just the method slot.
		1393	# due to bugs in perls method cache implementation.
1220	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1394	our @methods = qw(io timer time now now_update signal child idle condvar);
1221		1395
1222	our @post_detect;
1223
1224	sub post_detect(&) {	1396	sub detect() {
1225	my ($cb) = @_;	1397	return $MODEL if $MODEL; # some programs keep references to detect
1226		1398
1227	if ($MODEL) {	1399	local $!; # for good measure
1228	$cb->();	1400	local $SIG{__DIE__}; # we use eval
1229		1401
1230	undef	1402	# free some memory
		1403	*detect = sub () { $MODEL };
		1404	# undef &func doesn't correctly update the method cache. grmbl.
		1405	# so we delete the whole glob. grmbl.
		1406	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1407	# a glob with an active sub. hrm. i hope it works, but perl is
		1408	# usually buggy in this department. sigh.
		1409	delete @{"AnyEvent::"}{@methods};
		1410	undef @methods;
		1411
		1412	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
		1413	my $model = $1;
		1414	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
		1415	if (eval "require $model") {
		1416	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
		1417	$MODEL = $model;
1231	} else {	1418	} else {
1232	push @post_detect, $cb;	1419	AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1233		1420	}
1234	defined wantarray
1235	? bless \$cb, "AnyEvent::Util::postdetect"
1236	: ()
1237	}	1421	}
1238	}
1239		1422
1240	sub AnyEvent::Util::postdetect::DESTROY {	1423	# check for already loaded models
1241	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1242	}
1243
1244	sub detect() {
1245	unless ($MODEL) {	1424	unless ($MODEL) {
1246	local $SIG{__DIE__};	1425	for (@REGISTRY, @models) {
1247		1426	my ($package, $model) = @$_;
1248	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1427	if (${"$package\::VERSION"} > 0) {
1249	my $model = "AnyEvent::Impl::$1";
1250	if (eval "require $model") {	1428	if (eval "require $model") {
		1429	AnyEvent::log 7 => "autodetected model '$model', using it.";
1251	$MODEL = $model;	1430	$MODEL = $model;
1252	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1431	last;
1253	} else {	1432	}
1254	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1255	}	1433	}
1256	}	1434	}
1257		1435
1258	# check for already loaded models
1259	unless ($MODEL) {	1436	unless ($MODEL) {
		1437	# try to autoload a model
1260	for (@REGISTRY, @models) {	1438	for (@REGISTRY, @models) {
1261	my ($package, $model) = @$_;	1439	my ($package, $model, $autoload) = @$_;
		1440	if (
		1441	$autoload
		1442	and eval "require $package"
1262	if (${"$package\::VERSION"} > 0) {	1443	and ${"$package\::VERSION"} > 0
1263	if (eval "require $model") {	1444	and eval "require $model"
		1445	) {
		1446	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1264	$MODEL = $model;	1447	$MODEL = $model;
1265	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1266	last;	1448	last;
1267	}
1268	}	1449	}
1269	}	1450	}
1270		1451
1271	unless ($MODEL) {
1272	# try to autoload a model
1273	for (@REGISTRY, @models) {
1274	my ($package, $model, $autoload) = @$_;
1275	if (
1276	$autoload
1277	and eval "require $package"
1278	and ${"$package\::VERSION"} > 0
1279	and eval "require $model"
1280	) {
1281	$MODEL = $model;
1282	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1283	last;
1284	}
1285	}
1286
1287	$MODEL	1452	$MODEL
1288	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1453	or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1289	}
1290	}	1454	}
1291
1292	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293
1294	unshift @ISA, $MODEL;
1295
1296	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1297
1298	(shift @post_detect)->() while @post_detect;
1299	}	1455	}
1300		1456
		1457	# free memory only needed for probing
		1458	undef @models;
		1459	undef @REGISTRY;
		1460
		1461	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1462
		1463	# now nuke some methods that are overridden by the backend.
		1464	# SUPER usage is not allowed in these.
		1465	for (qw(time signal child idle)) {
		1466	undef &{"AnyEvent::Base::$_"}
		1467	if defined &{"$MODEL\::$_"};
		1468	}
		1469
		1470	_isa_set;
		1471
		1472	# we're officially open!
		1473
		1474	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1475	require AnyEvent::Strict;
		1476	}
		1477
		1478	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1479	require AnyEvent::Debug;
		1480	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1481	}
		1482
		1483	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1484	require AnyEvent::Socket;
		1485	require AnyEvent::Debug;
		1486
		1487	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1488	$shell =~ s/\$\$/$$/g;
		1489
		1490	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1491	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1492	}
		1493
		1494	# now the anyevent environment is set up as the user told us to, so
		1495	# call the actual user code - post detects
		1496
		1497	(shift @post_detect)->() while @post_detect;
		1498	undef @post_detect;
		1499
		1500	*post_detect = sub(&) {
		1501	shift->();
		1502
		1503	undef
		1504	};
		1505
1301	$MODEL	1506	$MODEL
1302	}	1507	}
1303		1508
1304	sub AUTOLOAD {	1509	for my $name (@methods) {
1305	(my $func = $AUTOLOAD) =~ s/.*://;	1510	*$name = sub {
1306		1511	detect;
1307	$method{$func}	1512	# we use goto because
1308	or Carp::croak "$func: not a valid method for AnyEvent objects";	1513	# a) it makes the thunk more transparent
1309		1514	# b) it allows us to delete the thunk later
1310	detect unless $MODEL;	1515	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1311		1516	};
1312	my $class = shift;
1313	$class->$func (@_);
1314	}	1517	}
1315		1518
1316	# utility function to dup a filehandle. this is used by many backends	1519	# utility function to dup a filehandle. this is used by many backends
1317	# to support binding more than one watcher per filehandle (they usually	1520	# to support binding more than one watcher per filehandle (they usually
1318	# allow only one watcher per fd, so we dup it to get a different one).	1521	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1332		1535
1333	=head1 SIMPLIFIED AE API	1536	=head1 SIMPLIFIED AE API
1334		1537
1335	Starting with version 5.0, AnyEvent officially supports a second, much	1538	Starting with version 5.0, AnyEvent officially supports a second, much
1336	simpler, API that is designed to reduce the calling, typing and memory	1539	simpler, API that is designed to reduce the calling, typing and memory
1337	overhead.	1540	overhead by using function call syntax and a fixed number of parameters.
1338		1541
1339	See the L<AE> manpage for details.	1542	See the L<AE> manpage for details.
1340		1543
1341	=cut	1544	=cut
1342		1545
1343	package AE;	1546	package AE;
1344		1547
1345	our $VERSION = $AnyEvent::VERSION;	1548	our $VERSION = $AnyEvent::VERSION;
1346		1549
		1550	sub _reset() {
		1551	eval q{
		1552	# fall back to the main API by default - backends and AnyEvent::Base
		1553	# implementations can overwrite these.
		1554
1347	sub io($$$) {	1555	sub io($$$) {
1348	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1556	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1349	}	1557	}
1350		1558
1351	sub timer($$$) {	1559	sub timer($$$) {
1352	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1560	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1353	}	1561	}
1354		1562
1355	sub signal($$) {	1563	sub signal($$) {
1356	AnyEvent->signal (signal => $_[0], cb => $_[1])	1564	AnyEvent->signal (signal => $_[0], cb => $_[1])
1357	}	1565	}
1358		1566
1359	sub child($$) {	1567	sub child($$) {
1360	AnyEvent->child (pid => $_[0], cb => $_[1])	1568	AnyEvent->child (pid => $_[0], cb => $_[1])
1361	}	1569	}
1362		1570
1363	sub idle($) {	1571	sub idle($) {
1364	AnyEvent->idle (cb => $_[0])	1572	AnyEvent->idle (cb => $_[0]);
1365	}	1573	}
1366		1574
1367	sub cv(;&) {	1575	sub cv(;&) {
1368	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1576	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1369	}	1577	}
1370		1578
1371	sub now() {	1579	sub now() {
1372	AnyEvent->now	1580	AnyEvent->now
1373	}	1581	}
1374		1582
1375	sub now_update() {	1583	sub now_update() {
1376	AnyEvent->now_update	1584	AnyEvent->now_update
1377	}	1585	}
1378		1586
1379	sub time() {	1587	sub time() {
1380	AnyEvent->time	1588	AnyEvent->time
		1589	}
		1590
		1591	*postpone = \&AnyEvent::postpone;
		1592	*log = \&AnyEvent::log;
		1593	};
		1594	die if $@;
1381	}	1595	}
		1596
		1597	BEGIN { _reset }
1382		1598
1383	package AnyEvent::Base;	1599	package AnyEvent::Base;
1384		1600
1385	# default implementations for many methods	1601	# default implementations for many methods
1386		1602
1387	sub _time() {	1603	sub time {
		1604	eval q{ # poor man's autoloading {}
1388	# probe for availability of Time::HiRes	1605	# probe for availability of Time::HiRes
1389	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1606	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1390	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1607	*time = sub { Time::HiRes::time () };
1391	*_time = \&Time::HiRes::time;	1608	*AE::time = \& Time::HiRes::time ;
		1609	*now = \&time;
		1610	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1392	# if (eval "use POSIX (); (POSIX::times())...	1611	# if (eval "use POSIX (); (POSIX::times())...
1393	} else {	1612	} else {
		1613	*time = sub { CORE::time };
		1614	*AE::time = sub (){ CORE::time };
		1615	*now = \&time;
1394	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1616	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1395	*_time = sub (){ time }; # epic fail	1617	}
1396	}	1618	};
		1619	die if $@;
1397		1620
1398	&_time	1621	&time
1399	}	1622	}
1400		1623
1401	sub time { _time }	1624	*now = \&time;
1402	sub now { _time }
1403	sub now_update { }	1625	sub now_update { }
1404		1626
		1627	sub _poll {
		1628	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1629	}
		1630
1405	# default implementation for ->condvar	1631	# default implementation for ->condvar
		1632	# in fact, the default should not be overwritten
1406		1633
1407	sub condvar {	1634	sub condvar {
		1635	eval q{ # poor man's autoloading {}
		1636	*condvar = sub {
1408	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1637	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1638	};
		1639
		1640	*AE::cv = sub (;&) {
		1641	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1642	};
		1643	};
		1644	die if $@;
		1645
		1646	&condvar
1409	}	1647	}
1410		1648
1411	# default implementation for ->signal	1649	# default implementation for ->signal
1412		1650
1413	our $HAVE_ASYNC_INTERRUPT;	1651	our $HAVE_ASYNC_INTERRUPT;
…		…
1422		1660
1423	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1661	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1424	our (%SIG_ASY, %SIG_ASY_W);	1662	our (%SIG_ASY, %SIG_ASY_W);
1425	our ($SIG_COUNT, $SIG_TW);	1663	our ($SIG_COUNT, $SIG_TW);
1426		1664
1427	sub _signal_exec {
1428	$HAVE_ASYNC_INTERRUPT
1429	? $SIGPIPE_R->drain
1430	: sysread $SIGPIPE_R, (my $dummy), 9;
1431
1432	while (%SIG_EV) {
1433	for (keys %SIG_EV) {
1434	delete $SIG_EV{$_};
1435	$_->() for values %{ $SIG_CB{$_} || {} };
1436	}
1437	}
1438	}
1439
1440	# install a dummy wakeup watcher to reduce signal catching latency	1665	# install a dummy wakeup watcher to reduce signal catching latency
		1666	# used by Impls
1441	sub _sig_add() {	1667	sub _sig_add() {
1442	unless ($SIG_COUNT++) {	1668	unless ($SIG_COUNT++) {
1443	# try to align timer on a full-second boundary, if possible	1669	# try to align timer on a full-second boundary, if possible
1444	my $NOW = AE::now;	1670	my $NOW = AE::now;
1445		1671
…		…
1455	undef $SIG_TW	1681	undef $SIG_TW
1456	unless --$SIG_COUNT;	1682	unless --$SIG_COUNT;
1457	}	1683	}
1458		1684
1459	our $_sig_name_init; $_sig_name_init = sub {	1685	our $_sig_name_init; $_sig_name_init = sub {
1460	eval q{ # poor man's autoloading	1686	eval q{ # poor man's autoloading {}
1461	undef $_sig_name_init;	1687	undef $_sig_name_init;
1462		1688
1463	if (_have_async_interrupt) {	1689	if (_have_async_interrupt) {
1464	*sig2num = \&Async::Interrupt::sig2num;	1690	*sig2num = \&Async::Interrupt::sig2num;
1465	*sig2name = \&Async::Interrupt::sig2name;	1691	*sig2name = \&Async::Interrupt::sig2name;
…		…
1489		1715
1490	sub signal {	1716	sub signal {
1491	eval q{ # poor man's autoloading {}	1717	eval q{ # poor man's autoloading {}
1492	# probe for availability of Async::Interrupt	1718	# probe for availability of Async::Interrupt
1493	if (_have_async_interrupt) {	1719	if (_have_async_interrupt) {
1494	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1720	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1495		1721
1496	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1722	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1497	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1723	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1498		1724
1499	} else {	1725	} else {
1500	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1726	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1501
1502	require Fcntl;
1503		1727
1504	if (AnyEvent::WIN32) {	1728	if (AnyEvent::WIN32) {
1505	require AnyEvent::Util;	1729	require AnyEvent::Util;
1506		1730
1507	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1731	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1508	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1732	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1509	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1733	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1510	} else {	1734	} else {
1511	pipe $SIGPIPE_R, $SIGPIPE_W;	1735	pipe $SIGPIPE_R, $SIGPIPE_W;
1512	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1736	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1513	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1737	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1514		1738
1515	# not strictly required, as $^F is normally 2, but let's make sure...	1739	# not strictly required, as $^F is normally 2, but let's make sure...
1516	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1740	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1517	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1741	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1518	}	1742	}
1519		1743
1520	$SIGPIPE_R	1744	$SIGPIPE_R
1521	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1745	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1522		1746
1523	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1747	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1524	}	1748	}
1525		1749
1526	*signal = sub {	1750	*signal = $HAVE_ASYNC_INTERRUPT
		1751	? sub {
1527	my (undef, %arg) = @_;	1752	my (undef, %arg) = @_;
1528		1753
1529	my $signal = uc $arg{signal}
1530	or Carp::croak "required option 'signal' is missing";
1531
1532	if ($HAVE_ASYNC_INTERRUPT) {
1533	# async::interrupt	1754	# async::interrupt
1534
1535	$signal = sig2num $signal;	1755	my $signal = sig2num $arg{signal};
1536	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1756	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1537		1757
1538	$SIG_ASY{$signal} ||= new Async::Interrupt	1758	$SIG_ASY{$signal} ||= new Async::Interrupt
1539	cb => sub { undef $SIG_EV{$signal} },	1759	cb => sub { undef $SIG_EV{$signal} },
1540	signal => $signal,	1760	signal => $signal,
1541	pipe => [$SIGPIPE_R->filenos],	1761	pipe => [$SIGPIPE_R->filenos],
1542	pipe_autodrain => 0,	1762	pipe_autodrain => 0,
1543	;	1763	;
1544		1764
1545	} else {	1765	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1766	}
		1767	: sub {
		1768	my (undef, %arg) = @_;
		1769
1546	# pure perl	1770	# pure perl
1547
1548	# AE::Util has been loaded in signal
1549	$signal = sig2name $signal;	1771	my $signal = sig2name $arg{signal};
1550	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1772	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1551		1773
1552	$SIG{$signal} ||= sub {	1774	$SIG{$signal} ||= sub {
1553	local $!;	1775	local $!;
1554	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1776	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1555	undef $SIG_EV{$signal};	1777	undef $SIG_EV{$signal};
1556	};	1778	};
1557		1779
1558	# can't do signal processing without introducing races in pure perl,	1780	# can't do signal processing without introducing races in pure perl,
1559	# so limit the signal latency.	1781	# so limit the signal latency.
1560	_sig_add;	1782	_sig_add;
1561	}
1562		1783
1563	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1784	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1785	}
1564	};	1786	;
1565		1787
1566	*AnyEvent::Base::signal::DESTROY = sub {	1788	*AnyEvent::Base::signal::DESTROY = sub {
1567	my ($signal, $cb) = @{$_[0]};	1789	my ($signal, $cb) = @{$_[0]};
1568		1790
1569	_sig_del;	1791	_sig_del;
…		…
1576	# print weird messages, or just unconditionally exit	1798	# print weird messages, or just unconditionally exit
1577	# instead of getting the default action.	1799	# instead of getting the default action.
1578	undef $SIG{$signal}	1800	undef $SIG{$signal}
1579	unless keys %{ $SIG_CB{$signal} };	1801	unless keys %{ $SIG_CB{$signal} };
1580	};	1802	};
		1803
		1804	*_signal_exec = sub {
		1805	$HAVE_ASYNC_INTERRUPT
		1806	? $SIGPIPE_R->drain
		1807	: sysread $SIGPIPE_R, (my $dummy), 9;
		1808
		1809	while (%SIG_EV) {
		1810	for (keys %SIG_EV) {
		1811	delete $SIG_EV{$_};
		1812	&$_ for values %{ $SIG_CB{$_} || {} };
		1813	}
		1814	}
		1815	};
1581	};	1816	};
1582	die if $@;	1817	die if $@;
		1818
1583	&signal	1819	&signal
1584	}	1820	}
1585		1821
1586	# default implementation for ->child	1822	# default implementation for ->child
1587		1823
1588	our %PID_CB;	1824	our %PID_CB;
1589	our $CHLD_W;	1825	our $CHLD_W;
1590	our $CHLD_DELAY_W;	1826	our $CHLD_DELAY_W;
1591	our $WNOHANG;
1592		1827
		1828	# used by many Impl's
1593	sub _emit_childstatus($$) {	1829	sub _emit_childstatus($$) {
1594	my (undef, $rpid, $rstatus) = @_;	1830	my (undef, $rpid, $rstatus) = @_;
1595		1831
1596	$_->($rpid, $rstatus)	1832	$_->($rpid, $rstatus)
1597	for values %{ $PID_CB{$rpid} || {} },	1833	for values %{ $PID_CB{$rpid} || {} },
1598	values %{ $PID_CB{0} || {} };	1834	values %{ $PID_CB{0} || {} };
1599	}	1835	}
1600		1836
1601	sub _sigchld {
1602	my $pid;
1603
1604	AnyEvent->_emit_childstatus ($pid, $?)
1605	while ($pid = waitpid -1, $WNOHANG) > 0;
1606	}
1607
1608	sub child {	1837	sub child {
		1838	eval q{ # poor man's autoloading {}
		1839	*_sigchld = sub {
		1840	my $pid;
		1841
		1842	AnyEvent->_emit_childstatus ($pid, $?)
		1843	while ($pid = waitpid -1, WNOHANG) > 0;
		1844	};
		1845
		1846	*child = sub {
1609	my (undef, %arg) = @_;	1847	my (undef, %arg) = @_;
1610		1848
1611	defined (my $pid = $arg{pid} + 0)	1849	my $pid = $arg{pid};
1612	or Carp::croak "required option 'pid' is missing";	1850	my $cb = $arg{cb};
1613		1851
1614	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1852	$PID_CB{$pid}{$cb+0} = $cb;
1615		1853
1616	# WNOHANG is almost cetrainly 1 everywhere
1617	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1618	? 1
1619	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1620
1621	unless ($CHLD_W) {	1854	unless ($CHLD_W) {
1622	$CHLD_W = AE::signal CHLD => \&_sigchld;	1855	$CHLD_W = AE::signal CHLD => \&_sigchld;
1623	# child could be a zombie already, so make at least one round	1856	# child could be a zombie already, so make at least one round
1624	&_sigchld;	1857	&_sigchld;
1625	}	1858	}
1626		1859
1627	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1860	bless [$pid, $cb+0], "AnyEvent::Base::child"
1628	}	1861	};
1629		1862
1630	sub AnyEvent::Base::child::DESTROY {	1863	*AnyEvent::Base::child::DESTROY = sub {
1631	my ($pid, $cb) = @{$_[0]};	1864	my ($pid, $icb) = @{$_[0]};
1632		1865
1633	delete $PID_CB{$pid}{$cb};	1866	delete $PID_CB{$pid}{$icb};
1634	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1867	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1635		1868
1636	undef $CHLD_W unless keys %PID_CB;	1869	undef $CHLD_W unless keys %PID_CB;
		1870	};
		1871	};
		1872	die if $@;
		1873
		1874	&child
1637	}	1875	}
1638		1876
1639	# idle emulation is done by simply using a timer, regardless	1877	# idle emulation is done by simply using a timer, regardless
1640	# of whether the process is idle or not, and not letting	1878	# of whether the process is idle or not, and not letting
1641	# the callback use more than 50% of the time.	1879	# the callback use more than 50% of the time.
1642	sub idle {	1880	sub idle {
		1881	eval q{ # poor man's autoloading {}
		1882	*idle = sub {
1643	my (undef, %arg) = @_;	1883	my (undef, %arg) = @_;
1644		1884
1645	my ($cb, $w, $rcb) = $arg{cb};	1885	my ($cb, $w, $rcb) = $arg{cb};
1646		1886
1647	$rcb = sub {	1887	$rcb = sub {
1648	if ($cb) {	1888	if ($cb) {
1649	$w = _time;	1889	$w = AE::time;
1650	&$cb;	1890	&$cb;
1651	$w = _time - $w;	1891	$w = AE::time - $w;
1652		1892
1653	# never use more then 50% of the time for the idle watcher,	1893	# never use more then 50% of the time for the idle watcher,
1654	# within some limits	1894	# within some limits
1655	$w = 0.0001 if $w < 0.0001;	1895	$w = 0.0001 if $w < 0.0001;
1656	$w = 5 if $w > 5;	1896	$w = 5 if $w > 5;
1657		1897
1658	$w = AE::timer $w, 0, $rcb;	1898	$w = AE::timer $w, 0, $rcb;
1659	} else {	1899	} else {
1660	# clean up...	1900	# clean up...
1661	undef $w;	1901	undef $w;
1662	undef $rcb;	1902	undef $rcb;
		1903	}
		1904	};
		1905
		1906	$w = AE::timer 0.05, 0, $rcb;
		1907
		1908	bless \\$cb, "AnyEvent::Base::idle"
1663	}	1909	};
		1910
		1911	*AnyEvent::Base::idle::DESTROY = sub {
		1912	undef $${$_[0]};
		1913	};
1664	};	1914	};
		1915	die if $@;
1665		1916
1666	$w = AE::timer 0.05, 0, $rcb;	1917	&idle
1667
1668	bless \\$cb, "AnyEvent::Base::idle"
1669	}
1670
1671	sub AnyEvent::Base::idle::DESTROY {
1672	undef $${$_[0]};
1673	}	1918	}
1674		1919
1675	package AnyEvent::CondVar;	1920	package AnyEvent::CondVar;
1676		1921
1677	our @ISA = AnyEvent::CondVar::Base::;	1922	our @ISA = AnyEvent::CondVar::Base::;
		1923
		1924	# only to be used for subclassing
		1925	sub new {
		1926	my $class = shift;
		1927	bless AnyEvent->condvar (@_), $class
		1928	}
1678		1929
1679	package AnyEvent::CondVar::Base;	1930	package AnyEvent::CondVar::Base;
1680		1931
1681	#use overload	1932	#use overload
1682	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1933	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
…		…
1692		1943
1693	sub _send {	1944	sub _send {
1694	# nop	1945	# nop
1695	}	1946	}
1696		1947
		1948	sub _wait {
		1949	AnyEvent->_poll until $_[0]{_ae_sent};
		1950	}
		1951
1697	sub send {	1952	sub send {
1698	my $cv = shift;	1953	my $cv = shift;
1699	$cv->{_ae_sent} = [@_];	1954	$cv->{_ae_sent} = [@_];
1700	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1955	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1701	$cv->_send;	1956	$cv->_send;
…		…
1708		1963
1709	sub ready {	1964	sub ready {
1710	$_[0]{_ae_sent}	1965	$_[0]{_ae_sent}
1711	}	1966	}
1712		1967
1713	sub _wait {
1714	$WAITING
1715	and !$_[0]{_ae_sent}
1716	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1717
1718	local $WAITING = 1;
1719	AnyEvent->one_event while !$_[0]{_ae_sent};
1720	}
1721
1722	sub recv {	1968	sub recv {
		1969	unless ($_[0]{_ae_sent}) {
		1970	$WAITING
		1971	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1972
		1973	local $WAITING = 1;
1723	$_[0]->_wait;	1974	$_[0]->_wait;
		1975	}
1724		1976
1725	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1977	$_[0]{_ae_croak}
1726	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1978	and Carp::croak $_[0]{_ae_croak};
		1979
		1980	wantarray
		1981	? @{ $_[0]{_ae_sent} }
		1982	: $_[0]{_ae_sent}[0]
1727	}	1983	}
1728		1984
1729	sub cb {	1985	sub cb {
1730	my $cv = shift;	1986	my $cv = shift;
1731		1987
…		…
1747	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	2003	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1748	}	2004	}
1749		2005
1750	# undocumented/compatibility with pre-3.4	2006	# undocumented/compatibility with pre-3.4
1751	*broadcast = \&send;	2007	*broadcast = \&send;
1752	*wait = \&_wait;	2008	*wait = \&recv;
1753		2009
1754	=head1 ERROR AND EXCEPTION HANDLING	2010	=head1 ERROR AND EXCEPTION HANDLING
1755		2011
1756	In general, AnyEvent does not do any error handling - it relies on the	2012	In general, AnyEvent does not do any error handling - it relies on the
1757	caller to do that if required. The L<AnyEvent::Strict> module (see also	2013	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1769	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2025	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1770	so on.	2026	so on.
1771		2027
1772	=head1 ENVIRONMENT VARIABLES	2028	=head1 ENVIRONMENT VARIABLES
1773		2029
1774	The following environment variables are used by this module or its	2030	AnyEvent supports a number of environment variables that tune the
1775	submodules.	2031	runtime behaviour. They are usually evaluated when AnyEvent is
		2032	loaded, initialised, or a submodule that uses them is loaded. Many of
		2033	them also cause AnyEvent to load additional modules - for example,
		2034	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2035	loaded.
1776		2036
1777	Note that AnyEvent will remove I<all> environment variables starting with	2037	All the environment variables documented here start with
1778	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2038	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1779	enabled.	2039	namespace. Other modules are encouraged (but by no means required) to use
		2040	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2041	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2042	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2043	variables starting with C<AE_>, see below).
		2044
		2045	All variables can also be set via the C<AE_> prefix, that is, instead
		2046	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2047	case there is a clash btween anyevent and another program that uses
		2048	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2049	variable to the empty string, as those variables take precedence.
		2050
		2051	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2052	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2053	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2054	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2055	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2056	is set).
		2057
		2058	The exact algorithm is currently:
		2059
		2060	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2061	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2062	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2063
		2064	This ensures that child processes will not see the C<AE_> variables.
		2065
		2066	The following environment variables are currently known to AnyEvent:
1780		2067
1781	=over 4	2068	=over 4
1782		2069
1783	=item C<PERL_ANYEVENT_VERBOSE>	2070	=item C<PERL_ANYEVENT_VERBOSE>
1784		2071
1785	By default, AnyEvent will be completely silent except in fatal	2072	By default, AnyEvent will only log messages with loglevel C<3>
1786	conditions. You can set this environment variable to make AnyEvent more	2073	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2074	environment variable to a numerical loglevel to make AnyEvent more (or
1787	talkative.	2075	less) talkative.
1788		2076
		2077	If you want to do more than just set the global logging level
		2078	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2079	complex specifications.
		2080
		2081	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2082	the default logging settings.
		2083
1789	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2084	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1790	conditions, such as not being able to load the event model specified by	2085	unexpected conditions, such as not being able to load the event model
1791	C<PERL_ANYEVENT_MODEL>.	2086	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2087	exception - this is the minimum recommended level.
1792		2088
1793	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2089	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1794	model it chooses.	2090	chooses.
1795		2091
1796	When set to C<8> or higher, then AnyEvent will report extra information on	2092	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1797	which optional modules it loads and how it implements certain features.	2093	which optional modules it loads and how it implements certain features.
		2094
		2095	=item C<PERL_ANYEVENT_LOG>
		2096
		2097	Accepts rather complex logging specifications. For example, you could log
		2098	all C<debug> messages of some module to stderr, warnings and above to
		2099	stderr, and errors and above to syslog, with:
		2100
		2101	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2102
		2103	For the rather extensive details, see L<AnyEvent::Log>.
		2104
		2105	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2106	so will take effect even before AnyEvent has initialised itself.
		2107
		2108	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2109	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2110	using the latter saves a few hundred kB of memory until the first message
		2111	is being logged.
1798		2112
1799	=item C<PERL_ANYEVENT_STRICT>	2113	=item C<PERL_ANYEVENT_STRICT>
1800		2114
1801	AnyEvent does not do much argument checking by default, as thorough	2115	AnyEvent does not do much argument checking by default, as thorough
1802	argument checking is very costly. Setting this variable to a true value	2116	argument checking is very costly. Setting this variable to a true value
…		…
1804	check the arguments passed to most method calls. If it finds any problems,	2118	check the arguments passed to most method calls. If it finds any problems,
1805	it will croak.	2119	it will croak.
1806		2120
1807	In other words, enables "strict" mode.	2121	In other words, enables "strict" mode.
1808		2122
1809	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	2123	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1810	>>, it is definitely recommended to keep it off in production. Keeping	2124	>>, it is definitely recommended to keep it off in production. Keeping
1811	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2125	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1812	can be very useful, however.	2126	can be very useful, however.
1813		2127
		2128	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2129
		2130	If this env variable is nonempty, then its contents will be interpreted by
		2131	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2132	replacing every occurance of C<$$> by the process pid). The shell object
		2133	is saved in C<$AnyEvent::Debug::SHELL>.
		2134
		2135	This happens when the first watcher is created.
		2136
		2137	For example, to bind a debug shell on a unix domain socket in
		2138	F<< /tmp/debug<pid>.sock >>, you could use this:
		2139
		2140	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2141	# connect with e.g.: socat readline /tmp/debug123.sock
		2142
		2143	Or to bind to tcp port 4545 on localhost:
		2144
		2145	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2146	# connect with e.g.: telnet localhost 4545
		2147
		2148	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2149	multiuser systems.
		2150
		2151	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2152
		2153	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2154	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2155
1814	=item C<PERL_ANYEVENT_MODEL>	2156	=item C<PERL_ANYEVENT_MODEL>
1815		2157
1816	This can be used to specify the event model to be used by AnyEvent, before	2158	This can be used to specify the event model to be used by AnyEvent, before
1817	auto detection and -probing kicks in. It must be a string consisting	2159	auto detection and -probing kicks in.
1818	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2160
		2161	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2162	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1819	and the resulting module name is loaded and if the load was successful,	2163	resulting module name is loaded and - if the load was successful - used as
1820	used as event model. If it fails to load AnyEvent will proceed with	2164	event model backend. If it fails to load then AnyEvent will proceed with
1821	auto detection and -probing.	2165	auto detection and -probing.
1822		2166
1823	This functionality might change in future versions.	2167	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2168	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2169	the end of a string designates a module name and quotes it appropriately).
1824		2170
1825	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2171	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1826	could start your program like this:	2172	could start your program like this:
1827		2173
1828	PERL_ANYEVENT_MODEL=Perl perl ...	2174	PERL_ANYEVENT_MODEL=Perl perl ...
1829		2175
1830	=item C<PERL_ANYEVENT_PROTOCOLS>	2176	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1846	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2192	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1847	- only support IPv4, never try to resolve or contact IPv6	2193	- only support IPv4, never try to resolve or contact IPv6
1848	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2194	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1849	IPv6, but prefer IPv6 over IPv4.	2195	IPv6, but prefer IPv6 over IPv4.
1850		2196
		2197	=item C<PERL_ANYEVENT_HOSTS>
		2198
		2199	This variable, if specified, overrides the F</etc/hosts> file used by
		2200	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2201	from that file instead.
		2202
1851	=item C<PERL_ANYEVENT_EDNS0>	2203	=item C<PERL_ANYEVENT_EDNS0>
1852		2204
1853	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2205	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1854	for DNS. This extension is generally useful to reduce DNS traffic, but	2206	DNS. This extension is generally useful to reduce DNS traffic, especially
1855	some (broken) firewalls drop such DNS packets, which is why it is off by	2207	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1856	default.	2208	packets, which is why it is off by default.
1857		2209
1858	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2210	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1859	EDNS0 in its DNS requests.	2211	EDNS0 in its DNS requests.
1860		2212
1861	=item C<PERL_ANYEVENT_MAX_FORKS>	2213	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1869	resolver - this is the maximum number of parallel DNS requests that are	2221	resolver - this is the maximum number of parallel DNS requests that are
1870	sent to the DNS server.	2222	sent to the DNS server.
1871		2223
1872	=item C<PERL_ANYEVENT_RESOLV_CONF>	2224	=item C<PERL_ANYEVENT_RESOLV_CONF>
1873		2225
1874	The file to use instead of F</etc/resolv.conf> (or OS-specific	2226	The absolute path to a F<resolv.conf>-style file to use instead of
1875	configuration) in the default resolver. When set to the empty string, no	2227	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1876	default config will be used.	2228	resolver, or the empty string to select the default configuration.
1877		2229
1878	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2230	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1879		2231
1880	When neither C<ca_file> nor C<ca_path> was specified during	2232	When neither C<ca_file> nor C<ca_path> was specified during
1881	L<AnyEvent::TLS> context creation, and either of these environment	2233	L<AnyEvent::TLS> context creation, and either of these environment
1882	variables exist, they will be used to specify CA certificate locations	2234	variables are nonempty, they will be used to specify CA certificate
1883	instead of a system-dependent default.	2235	locations instead of a system-dependent default.
1884		2236
1885	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2237	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1886		2238
1887	When these are set to C<1>, then the respective modules are not	2239	When these are set to C<1>, then the respective modules are not
1888	loaded. Mostly good for testing AnyEvent itself.	2240	loaded. Mostly good for testing AnyEvent itself.
…		…
2036		2388
2037	The actual code goes further and collects all errors (C<die>s, exceptions)	2389	The actual code goes further and collects all errors (C<die>s, exceptions)
2038	that occurred during request processing. The C<result> method detects	2390	that occurred during request processing. The C<result> method detects
2039	whether an exception as thrown (it is stored inside the $txn object)	2391	whether an exception as thrown (it is stored inside the $txn object)
2040	and just throws the exception, which means connection errors and other	2392	and just throws the exception, which means connection errors and other
2041	problems get reported tot he code that tries to use the result, not in a	2393	problems get reported to the code that tries to use the result, not in a
2042	random callback.	2394	random callback.
2043		2395
2044	All of this enables the following usage styles:	2396	All of this enables the following usage styles:
2045		2397
2046	1. Blocking:	2398	1. Blocking:
…		…
2220	(even when used without AnyEvent), but most event loops have acceptable	2572	(even when used without AnyEvent), but most event loops have acceptable
2221	performance with or without AnyEvent.	2573	performance with or without AnyEvent.
2222		2574
2223	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2575	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2224	the actual event loop, only with extremely fast event loops such as EV	2576	the actual event loop, only with extremely fast event loops such as EV
2225	adds AnyEvent significant overhead.	2577	does AnyEvent add significant overhead.
2226		2578
2227	=item * You should avoid POE like the plague if you want performance or	2579	=item * You should avoid POE like the plague if you want performance or
2228	reasonable memory usage.	2580	reasonable memory usage.
2229		2581
2230	=back	2582	=back
…		…
2460	unless defined $SIG{PIPE};	2812	unless defined $SIG{PIPE};
2461		2813
2462	=head1 RECOMMENDED/OPTIONAL MODULES	2814	=head1 RECOMMENDED/OPTIONAL MODULES
2463		2815
2464	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2816	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2465	it's built-in modules) are required to use it.	2817	its built-in modules) are required to use it.
2466		2818
2467	That does not mean that AnyEvent won't take advantage of some additional	2819	That does not mean that AnyEvent won't take advantage of some additional
2468	modules if they are installed.	2820	modules if they are installed.
2469		2821
2470	This section explains which additional modules will be used, and how they	2822	This section explains which additional modules will be used, and how they
…		…
2503	automatic timer adjustments even when no monotonic clock is available,	2855	automatic timer adjustments even when no monotonic clock is available,
2504	can take avdantage of advanced kernel interfaces such as C<epoll> and	2856	can take avdantage of advanced kernel interfaces such as C<epoll> and
2505	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2857	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2506	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2858	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2507		2859
		2860	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2861	then this module will do nothing for you.
		2862
2508	=item L<Guard>	2863	=item L<Guard>
2509		2864
2510	The guard module, when used, will be used to implement	2865	The guard module, when used, will be used to implement
2511	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2866	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2512	lot less memory), but otherwise doesn't affect guard operation much. It is	2867	lot less memory), but otherwise doesn't affect guard operation much. It is
2513	purely used for performance.	2868	purely used for performance.
2514		2869
2515	=item L<JSON> and L<JSON::XS>	2870	=item L<JSON> and L<JSON::XS>
2516		2871
2517	One of these modules is required when you want to read or write JSON data	2872	One of these modules is required when you want to read or write JSON data
2518	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2873	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2519	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2874	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2520
2521	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2522	installed.
2523		2875
2524	=item L<Net::SSLeay>	2876	=item L<Net::SSLeay>
2525		2877
2526	Implementing TLS/SSL in Perl is certainly interesting, but not very	2878	Implementing TLS/SSL in Perl is certainly interesting, but not very
2527	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2879	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2528	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2880	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2529		2881
2530	=item L<Time::HiRes>	2882	=item L<Time::HiRes>
2531		2883
2532	This module is part of perl since release 5.008. It will be used when the	2884	This module is part of perl since release 5.008. It will be used when the
2533	chosen event library does not come with a timing source on it's own. The	2885	chosen event library does not come with a timing source of its own. The
2534	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2886	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2535	try to use a monotonic clock for timing stability.	2887	try to use a monotonic clock for timing stability.
2536		2888
2537	=back	2889	=back
2538		2890
2539		2891
…		…
2601	pronounced).	2953	pronounced).
2602		2954
2603		2955
2604	=head1 SEE ALSO	2956	=head1 SEE ALSO
2605		2957
2606	Utility functions: L<AnyEvent::Util>.	2958	Tutorial/Introduction: L<AnyEvent::Intro>.
2607		2959
2608	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2960	FAQ: L<AnyEvent::FAQ>.
2609	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2961
		2962	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2963	(simply logging).
		2964
		2965	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2966	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2967
		2968	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2969	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2970	L<Qt>, L<POE>, L<FLTK>.
2610		2971
2611	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2972	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2612	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2973	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2613	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2974	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2614	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2975	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2976	L<AnyEvent::Impl::FLTK>.
2615		2977
2616	Non-blocking file handles, sockets, TCP clients and	2978	Non-blocking handles, pipes, stream sockets, TCP clients and
2617	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2979	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2618		2980
2619	Asynchronous DNS: L<AnyEvent::DNS>.	2981	Asynchronous DNS: L<AnyEvent::DNS>.
2620		2982
2621	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2983	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2622	L<Coro::Event>,
2623		2984
2624	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2985	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2625	L<AnyEvent::HTTP>.	2986	L<AnyEvent::HTTP>.
2626		2987
2627		2988
2628	=head1 AUTHOR	2989	=head1 AUTHOR
2629		2990

Diff Legend

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