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.363 by root, Sun Aug 14 13:56:52 2011 UTC

…		…
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::FLTK2 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
994	=back	1054	=back
995		1055
996	=head1 WHAT TO DO IN A MODULE	1056	=head1 WHAT TO DO IN A MODULE
997		1057
998	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1058	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	1068	because it will stall the whole program, and the whole point of using
1009	events is to stay interactive.	1069	events is to stay interactive.
1010		1070
1011	It is fine, however, to call C<< ->recv >> when the user of your module	1071	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	1072	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 >>	1073	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).	1074	freely, as the user of your module knows what she is doing. Always).
1015		1075
1016	=head1 WHAT TO DO IN THE MAIN PROGRAM	1076	=head1 WHAT TO DO IN THE MAIN PROGRAM
1017		1077
1018	There will always be a single main program - the only place that should	1078	There will always be a single main program - the only place that should
1019	dictate which event model to use.	1079	dictate which event model to use.
1020		1080
1021	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1081	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	1082	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.	1083	uses AnyEvent, but does not care which event loop is used, all it needs
		1084	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1085	available loop implementation.
1024		1086
1025	If the main program relies on a specific event model - for example, in	1087	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	1088	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	1089	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	1090	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	1091	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	1092	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.	1093	might choose the wrong one unless you load the correct one yourself.
1032		1094
1033	You can chose to use a pure-perl implementation by loading the	1095	You can chose to use a pure-perl implementation by loading the
1034	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1096	C<AnyEvent::Loop> module, which gives you similar behaviour
1035	everywhere, but letting AnyEvent chose the model is generally better.	1097	everywhere, but letting AnyEvent chose the model is generally better.
1036		1098
1037	=head2 MAINLOOP EMULATION	1099	=head2 MAINLOOP EMULATION
1038		1100
1039	Sometimes (often for short test scripts, or even standalone programs who	1101	Sometimes (often for short test scripts, or even standalone programs who
…		…
1054	=head1 OTHER MODULES	1116	=head1 OTHER MODULES
1055		1117
1056	The following is a non-exhaustive list of additional modules that use	1118	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	1119	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1058	modules and other event loops in the same program. Some of the modules	1120	modules and other event loops in the same program. Some of the modules
1059	come with AnyEvent, most are available via CPAN.	1121	come as part of AnyEvent, the others are available via CPAN.
1060		1122
1061	=over 4	1123	=over 4
1062		1124
1063	=item L<AnyEvent::Util>	1125	=item L<AnyEvent::Util>
1064		1126
1065	Contains various utility functions that replace often-used but blocking	1127	Contains various utility functions that replace often-used blocking
1066	functions such as C<inet_aton> by event-/callback-based versions.	1128	functions such as C<inet_aton> with event/callback-based versions.
1067		1129
1068	=item L<AnyEvent::Socket>	1130	=item L<AnyEvent::Socket>
1069		1131
1070	Provides various utility functions for (internet protocol) sockets,	1132	Provides various utility functions for (internet protocol) sockets,
1071	addresses and name resolution. Also functions to create non-blocking tcp	1133	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1073		1135
1074	=item L<AnyEvent::Handle>	1136	=item L<AnyEvent::Handle>
1075		1137
1076	Provide read and write buffers, manages watchers for reads and writes,	1138	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	1139	supports raw and formatted I/O, I/O queued and fully transparent and
1078	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1140	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1079		1141
1080	=item L<AnyEvent::DNS>	1142	=item L<AnyEvent::DNS>
1081		1143
1082	Provides rich asynchronous DNS resolver capabilities.	1144	Provides rich asynchronous DNS resolver capabilities.
1083		1145
		1146	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1147
		1148	Implement event-based interfaces to the protocols of the same name (for
		1149	the curious, IGS is the International Go Server and FCP is the Freenet
		1150	Client Protocol).
		1151
		1152	=item L<AnyEvent::Handle::UDP>
		1153
		1154	Here be danger!
		1155
		1156	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1157	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1158	its use of a stream-based API with a protocol that isn't streamable, that
		1159	the only way to improve it is to delete it.
		1160
		1161	It features data corruption (but typically only under load) and general
		1162	confusion. On top, the author is not only clueless about UDP but also
		1163	fact-resistant - some gems of his understanding: "connect doesn't work
		1164	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1165	packets", "I don't need to implement proper error checking as UDP doesn't
		1166	support error checking" and so on - he doesn't even understand what's
		1167	wrong with his module when it is explained to him.
		1168
1084	=item L<AnyEvent::HTTP>	1169	=item L<AnyEvent::DBI>
1085		1170
1086	A simple-to-use HTTP library that is capable of making a lot of concurrent	1171	Executes L<DBI> requests asynchronously in a proxy process for you,
1087	HTTP requests.	1172	notifying you in an event-based way when the operation is finished.
		1173
		1174	=item L<AnyEvent::AIO>
		1175
		1176	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1177	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1178	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1179	file I/O, and much more.
1088		1180
1089	=item L<AnyEvent::HTTPD>	1181	=item L<AnyEvent::HTTPD>
1090		1182
1091	Provides a simple web application server framework.	1183	A simple embedded webserver.
1092		1184
1093	=item L<AnyEvent::FastPing>	1185	=item L<AnyEvent::FastPing>
1094		1186
1095	The fastest ping in the west.	1187	The fastest ping in the west.
1096
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		1188
1139	=item L<Coro>	1189	=item L<Coro>
1140		1190
1141	Has special support for AnyEvent via L<Coro::AnyEvent>.	1191	Has special support for AnyEvent via L<Coro::AnyEvent>.
1142		1192
…		…
1146		1196
1147	package AnyEvent;	1197	package AnyEvent;
1148		1198
1149	# basically a tuned-down version of common::sense	1199	# basically a tuned-down version of common::sense
1150	sub common_sense {	1200	sub common_sense {
1151	# from common:.sense 1.0	1201	# from common:.sense 3.4
1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1202	${^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)	1203	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1154	$^H |= 0x00000600;	1204	$^H |= 0x00000600;
1155	}	1205	}
1156		1206
1157	BEGIN { AnyEvent::common_sense }	1207	BEGIN { AnyEvent::common_sense }
1158		1208
1159	use Carp ();	1209	use Carp ();
1160		1210
1161	our $VERSION = '5.24';	1211	our $VERSION = '6.01';
1162	our $MODEL;	1212	our $MODEL;
1163		1213
1164	our $AUTOLOAD;
1165	our @ISA;	1214	our @ISA;
1166		1215
1167	our @REGISTRY;	1216	our @REGISTRY;
1168		1217
1169	our $VERBOSE;	1218	our $VERBOSE;
1170		1219
1171	BEGIN {	1220	BEGIN {
1172	eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";	1221	require "AnyEvent/constants.pl";
1173	eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";	1222
1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";	1223	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1175		1224
1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1225	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1177	if ${^TAINT};	1226	if ${^TAINT};
1178		1227
1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1228	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1189	$PROTOCOL{$_} = ++$idx	1238	$PROTOCOL{$_} = ++$idx
1190	for reverse split /\s*,\s*/,	1239	for reverse split /\s*,\s*/,
1191	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1240	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1192	}	1241	}
1193		1242
		1243	our @post_detect;
		1244
		1245	sub post_detect(&) {
		1246	my ($cb) = @_;
		1247
		1248	push @post_detect, $cb;
		1249
		1250	defined wantarray
		1251	? bless \$cb, "AnyEvent::Util::postdetect"
		1252	: ()
		1253	}
		1254
		1255	sub AnyEvent::Util::postdetect::DESTROY {
		1256	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1257	}
		1258
		1259	our $POSTPONE_W;
		1260	our @POSTPONE;
		1261
		1262	sub _postpone_exec {
		1263	undef $POSTPONE_W;
		1264
		1265	&{ shift @POSTPONE }
		1266	while @POSTPONE;
		1267	}
		1268
		1269	sub postpone(&) {
		1270	push @POSTPONE, shift;
		1271
		1272	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1273
		1274	()
		1275	}
		1276
1194	my @models = (	1277	our @models = (
1195	[EV:: => AnyEvent::Impl::EV:: , 1],	1278	[EV:: => AnyEvent::Impl::EV:: , 1],
1196	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1279	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1197	# everything below here will not (normally) be autoprobed	1280	# everything below here will not (normally) be autoprobed
1198	# as the pureperl backend should work everywhere	1281	# as the pure perl backend should work everywhere
1199	# and is usually faster	1282	# and is usually faster
1200	[Event:: => AnyEvent::Impl::Event::, 1],	1283	[Event:: => AnyEvent::Impl::Event::, 1],
1201	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1284	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1202	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1285	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1203	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1286	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1204	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1287	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1205	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1288	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1206	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1289	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1207	[Wx:: => AnyEvent::Impl::POE::],	1290	[Wx:: => AnyEvent::Impl::POE::],
1208	[Prima:: => AnyEvent::Impl::POE::],	1291	[Prima:: => AnyEvent::Impl::POE::],
1209	# IO::Async is just too broken - we would need workarounds for its	1292	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1210	# byzantine signal and broken child handling, among others.	1293	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1211	# IO::Async is rather hard to detect, as it doesn't have any	1294	[FLTK:: => AnyEvent::Impl::FLTK2::],
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	);	1295	);
1218		1296
1219	our %method = map +($_ => 1),	1297	our @isa_hook;
		1298
		1299	sub _isa_set {
		1300	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1301
		1302	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1303	for 1 .. $#pkg;
		1304
		1305	grep $_ && $_->[1], @isa_hook
		1306	and AE::_reset ();
		1307	}
		1308
		1309	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1310	sub _isa_hook($$;$) {
		1311	my ($i, $pkg, $reset_ae) = @_;
		1312
		1313	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1314
		1315	_isa_set;
		1316	}
		1317
		1318	# all autoloaded methods reserve the complete glob, not just the method slot.
		1319	# due to bugs in perls method cache implementation.
1220	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1320	our @methods = qw(io timer time now now_update signal child idle condvar);
1221		1321
1222	our @post_detect;
1223
1224	sub post_detect(&) {	1322	sub detect() {
1225	my ($cb) = @_;	1323	return $MODEL if $MODEL; # some programs keep references to detect
1226		1324
1227	if ($MODEL) {	1325	local $!; # for good measure
1228	$cb->();	1326	local $SIG{__DIE__}; # we use eval
1229		1327
1230	undef	1328	# free some memory
		1329	*detect = sub () { $MODEL };
		1330	# undef &func doesn't correctly update the method cache. grmbl.
		1331	# so we delete the whole glob. grmbl.
		1332	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1333	# a glob with an active sub. hrm. i hope it works, but perl is
		1334	# usually buggy in this department. sigh.
		1335	delete @{"AnyEvent::"}{@methods};
		1336	undef @methods;
		1337
		1338	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
		1339	my $model = $1;
		1340	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
		1341	if (eval "require $model") {
		1342	$MODEL = $model;
		1343	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1231	} else {	1344	} else {
1232	push @post_detect, $cb;	1345	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1233		1346	}
1234	defined wantarray
1235	? bless \$cb, "AnyEvent::Util::postdetect"
1236	: ()
1237	}	1347	}
1238	}
1239		1348
1240	sub AnyEvent::Util::postdetect::DESTROY {	1349	# check for already loaded models
1241	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1242	}
1243
1244	sub detect() {
1245	unless ($MODEL) {	1350	unless ($MODEL) {
1246	local $SIG{__DIE__};	1351	for (@REGISTRY, @models) {
1247		1352	my ($package, $model) = @$_;
1248	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1353	if (${"$package\::VERSION"} > 0) {
1249	my $model = "AnyEvent::Impl::$1";
1250	if (eval "require $model") {	1354	if (eval "require $model") {
1251	$MODEL = $model;	1355	$MODEL = $model;
1252	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1356	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1253	} else {	1357	last;
1254	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1358	}
1255	}	1359	}
1256	}	1360	}
1257		1361
1258	# check for already loaded models
1259	unless ($MODEL) {	1362	unless ($MODEL) {
		1363	# try to autoload a model
1260	for (@REGISTRY, @models) {	1364	for (@REGISTRY, @models) {
1261	my ($package, $model) = @$_;	1365	my ($package, $model, $autoload) = @$_;
		1366	if (
		1367	$autoload
		1368	and eval "require $package"
1262	if (${"$package\::VERSION"} > 0) {	1369	and ${"$package\::VERSION"} > 0
1263	if (eval "require $model") {	1370	and eval "require $model"
		1371	) {
1264	$MODEL = $model;	1372	$MODEL = $model;
1265	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1373	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1266	last;	1374	last;
1267	}
1268	}	1375	}
1269	}	1376	}
1270		1377
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	1378	$MODEL
1288	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1379	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1289	}
1290	}	1380	}
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	}	1381	}
1300		1382
		1383	# free memory only needed for probing
		1384	undef @models;
		1385	undef @REGISTRY;
		1386
		1387	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1388
		1389	# now nuke some methods that are overridden by the backend.
		1390	# SUPER usage is not allowed in these.
		1391	for (qw(time signal child idle)) {
		1392	undef &{"AnyEvent::Base::$_"}
		1393	if defined &{"$MODEL\::$_"};
		1394	}
		1395
		1396	_isa_set;
		1397
		1398	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1399	require AnyEvent::Strict;
		1400	}
		1401
		1402	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1403	require AnyEvent::Debug;
		1404	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1405	}
		1406
		1407	if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1408	require AnyEvent::Socket;
		1409	require AnyEvent::Debug;
		1410
		1411	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1412	$shell =~ s/\$\$/$$/g;
		1413
		1414	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1415	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1416	}
		1417
		1418	(shift @post_detect)->() while @post_detect;
		1419	undef @post_detect;
		1420
		1421	*post_detect = sub(&) {
		1422	shift->();
		1423
		1424	undef
		1425	};
		1426
1301	$MODEL	1427	$MODEL
1302	}	1428	}
1303		1429
1304	sub AUTOLOAD {	1430	for my $name (@methods) {
1305	(my $func = $AUTOLOAD) =~ s/.*://;	1431	*$name = sub {
1306		1432	detect;
1307	$method{$func}	1433	# we use goto because
1308	or Carp::croak "$func: not a valid method for AnyEvent objects";	1434	# a) it makes the thunk more transparent
1309		1435	# b) it allows us to delete the thunk later
1310	detect unless $MODEL;	1436	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1311		1437	};
1312	my $class = shift;
1313	$class->$func (@_);
1314	}	1438	}
1315		1439
1316	# utility function to dup a filehandle. this is used by many backends	1440	# utility function to dup a filehandle. this is used by many backends
1317	# to support binding more than one watcher per filehandle (they usually	1441	# 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).	1442	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1332		1456
1333	=head1 SIMPLIFIED AE API	1457	=head1 SIMPLIFIED AE API
1334		1458
1335	Starting with version 5.0, AnyEvent officially supports a second, much	1459	Starting with version 5.0, AnyEvent officially supports a second, much
1336	simpler, API that is designed to reduce the calling, typing and memory	1460	simpler, API that is designed to reduce the calling, typing and memory
1337	overhead.	1461	overhead by using function call syntax and a fixed number of parameters.
1338		1462
1339	See the L<AE> manpage for details.	1463	See the L<AE> manpage for details.
1340		1464
1341	=cut	1465	=cut
1342		1466
1343	package AE;	1467	package AE;
1344		1468
1345	our $VERSION = $AnyEvent::VERSION;	1469	our $VERSION = $AnyEvent::VERSION;
1346		1470
		1471	sub _reset() {
		1472	eval q{
		1473	# fall back to the main API by default - backends and AnyEvent::Base
		1474	# implementations can overwrite these.
		1475
1347	sub io($$$) {	1476	sub io($$$) {
1348	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1477	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1349	}	1478	}
1350		1479
1351	sub timer($$$) {	1480	sub timer($$$) {
1352	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1481	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1353	}	1482	}
1354		1483
1355	sub signal($$) {	1484	sub signal($$) {
1356	AnyEvent->signal (signal => $_[0], cb => $_[1])	1485	AnyEvent->signal (signal => $_[0], cb => $_[1])
1357	}	1486	}
1358		1487
1359	sub child($$) {	1488	sub child($$) {
1360	AnyEvent->child (pid => $_[0], cb => $_[1])	1489	AnyEvent->child (pid => $_[0], cb => $_[1])
1361	}	1490	}
1362		1491
1363	sub idle($) {	1492	sub idle($) {
1364	AnyEvent->idle (cb => $_[0])	1493	AnyEvent->idle (cb => $_[0]);
1365	}	1494	}
1366		1495
1367	sub cv(;&) {	1496	sub cv(;&) {
1368	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1497	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1369	}	1498	}
1370		1499
1371	sub now() {	1500	sub now() {
1372	AnyEvent->now	1501	AnyEvent->now
1373	}	1502	}
1374		1503
1375	sub now_update() {	1504	sub now_update() {
1376	AnyEvent->now_update	1505	AnyEvent->now_update
1377	}	1506	}
1378		1507
1379	sub time() {	1508	sub time() {
1380	AnyEvent->time	1509	AnyEvent->time
		1510	}
		1511
		1512	*postpone = \&AnyEvent::postpone;
		1513	};
		1514	die if $@;
1381	}	1515	}
		1516
		1517	BEGIN { _reset }
1382		1518
1383	package AnyEvent::Base;	1519	package AnyEvent::Base;
1384		1520
1385	# default implementations for many methods	1521	# default implementations for many methods
1386		1522
1387	sub _time() {	1523	sub time {
		1524	eval q{ # poor man's autoloading {}
1388	# probe for availability of Time::HiRes	1525	# probe for availability of Time::HiRes
1389	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1526	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1390	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1527	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
		1528	*time = sub { Time::HiRes::time () };
1391	*_time = \&Time::HiRes::time;	1529	*AE::time = \& Time::HiRes::time ;
1392	# if (eval "use POSIX (); (POSIX::times())...	1530	# if (eval "use POSIX (); (POSIX::times())...
1393	} else {	1531	} else {
1394	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1532	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1395	*_time = sub (){ time }; # epic fail	1533	*time = sub { CORE::time };
		1534	*AE::time = sub (){ CORE::time };
		1535	}
		1536
		1537	*now = \&time;
1396	}	1538	};
		1539	die if $@;
1397		1540
1398	&_time	1541	&time
1399	}	1542	}
1400		1543
1401	sub time { _time }	1544	*now = \&time;
1402	sub now { _time }
1403	sub now_update { }	1545	sub now_update { }
1404		1546
		1547	sub _poll {
		1548	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1549	}
		1550
1405	# default implementation for ->condvar	1551	# default implementation for ->condvar
		1552	# in fact, the default should not be overwritten
1406		1553
1407	sub condvar {	1554	sub condvar {
		1555	eval q{ # poor man's autoloading {}
		1556	*condvar = sub {
1408	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1557	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1558	};
		1559
		1560	*AE::cv = sub (;&) {
		1561	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1562	};
		1563	};
		1564	die if $@;
		1565
		1566	&condvar
1409	}	1567	}
1410		1568
1411	# default implementation for ->signal	1569	# default implementation for ->signal
1412		1570
1413	our $HAVE_ASYNC_INTERRUPT;	1571	our $HAVE_ASYNC_INTERRUPT;
…		…
1422		1580
1423	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1581	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1424	our (%SIG_ASY, %SIG_ASY_W);	1582	our (%SIG_ASY, %SIG_ASY_W);
1425	our ($SIG_COUNT, $SIG_TW);	1583	our ($SIG_COUNT, $SIG_TW);
1426		1584
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	1585	# install a dummy wakeup watcher to reduce signal catching latency
		1586	# used by Impls
1441	sub _sig_add() {	1587	sub _sig_add() {
1442	unless ($SIG_COUNT++) {	1588	unless ($SIG_COUNT++) {
1443	# try to align timer on a full-second boundary, if possible	1589	# try to align timer on a full-second boundary, if possible
1444	my $NOW = AE::now;	1590	my $NOW = AE::now;
1445		1591
…		…
1455	undef $SIG_TW	1601	undef $SIG_TW
1456	unless --$SIG_COUNT;	1602	unless --$SIG_COUNT;
1457	}	1603	}
1458		1604
1459	our $_sig_name_init; $_sig_name_init = sub {	1605	our $_sig_name_init; $_sig_name_init = sub {
1460	eval q{ # poor man's autoloading	1606	eval q{ # poor man's autoloading {}
1461	undef $_sig_name_init;	1607	undef $_sig_name_init;
1462		1608
1463	if (_have_async_interrupt) {	1609	if (_have_async_interrupt) {
1464	*sig2num = \&Async::Interrupt::sig2num;	1610	*sig2num = \&Async::Interrupt::sig2num;
1465	*sig2name = \&Async::Interrupt::sig2name;	1611	*sig2name = \&Async::Interrupt::sig2name;
…		…
1497	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1643	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1498		1644
1499	} else {	1645	} else {
1500	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1646	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1501		1647
1502	require Fcntl;
1503
1504	if (AnyEvent::WIN32) {	1648	if (AnyEvent::WIN32) {
1505	require AnyEvent::Util;	1649	require AnyEvent::Util;
1506		1650
1507	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1651	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1508	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1652	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1509	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1653	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1510	} else {	1654	} else {
1511	pipe $SIGPIPE_R, $SIGPIPE_W;	1655	pipe $SIGPIPE_R, $SIGPIPE_W;
1512	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1656	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	1657	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1514		1658
1515	# not strictly required, as $^F is normally 2, but let's make sure...	1659	# not strictly required, as $^F is normally 2, but let's make sure...
1516	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1660	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1517	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1661	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1518	}	1662	}
1519		1663
1520	$SIGPIPE_R	1664	$SIGPIPE_R
1521	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1665	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1522		1666
1523	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1667	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1524	}	1668	}
1525		1669
1526	*signal = sub {	1670	*signal = $HAVE_ASYNC_INTERRUPT
		1671	? sub {
1527	my (undef, %arg) = @_;	1672	my (undef, %arg) = @_;
1528		1673
1529	my $signal = uc $arg{signal}
1530	or Carp::croak "required option 'signal' is missing";
1531
1532	if ($HAVE_ASYNC_INTERRUPT) {
1533	# async::interrupt	1674	# async::interrupt
1534
1535	$signal = sig2num $signal;	1675	my $signal = sig2num $arg{signal};
1536	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1676	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1537		1677
1538	$SIG_ASY{$signal} ||= new Async::Interrupt	1678	$SIG_ASY{$signal} ||= new Async::Interrupt
1539	cb => sub { undef $SIG_EV{$signal} },	1679	cb => sub { undef $SIG_EV{$signal} },
1540	signal => $signal,	1680	signal => $signal,
1541	pipe => [$SIGPIPE_R->filenos],	1681	pipe => [$SIGPIPE_R->filenos],
1542	pipe_autodrain => 0,	1682	pipe_autodrain => 0,
1543	;	1683	;
1544		1684
1545	} else {	1685	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1686	}
		1687	: sub {
		1688	my (undef, %arg) = @_;
		1689
1546	# pure perl	1690	# pure perl
1547
1548	# AE::Util has been loaded in signal
1549	$signal = sig2name $signal;	1691	my $signal = sig2name $arg{signal};
1550	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1692	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1551		1693
1552	$SIG{$signal} ||= sub {	1694	$SIG{$signal} ||= sub {
1553	local $!;	1695	local $!;
1554	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1696	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1555	undef $SIG_EV{$signal};	1697	undef $SIG_EV{$signal};
1556	};	1698	};
1557		1699
1558	# can't do signal processing without introducing races in pure perl,	1700	# can't do signal processing without introducing races in pure perl,
1559	# so limit the signal latency.	1701	# so limit the signal latency.
1560	_sig_add;	1702	_sig_add;
1561	}
1562		1703
1563	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1704	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1705	}
1564	};	1706	;
1565		1707
1566	*AnyEvent::Base::signal::DESTROY = sub {	1708	*AnyEvent::Base::signal::DESTROY = sub {
1567	my ($signal, $cb) = @{$_[0]};	1709	my ($signal, $cb) = @{$_[0]};
1568		1710
1569	_sig_del;	1711	_sig_del;
…		…
1576	# print weird messages, or just unconditionally exit	1718	# print weird messages, or just unconditionally exit
1577	# instead of getting the default action.	1719	# instead of getting the default action.
1578	undef $SIG{$signal}	1720	undef $SIG{$signal}
1579	unless keys %{ $SIG_CB{$signal} };	1721	unless keys %{ $SIG_CB{$signal} };
1580	};	1722	};
		1723
		1724	*_signal_exec = sub {
		1725	$HAVE_ASYNC_INTERRUPT
		1726	? $SIGPIPE_R->drain
		1727	: sysread $SIGPIPE_R, (my $dummy), 9;
		1728
		1729	while (%SIG_EV) {
		1730	for (keys %SIG_EV) {
		1731	delete $SIG_EV{$_};
		1732	&$_ for values %{ $SIG_CB{$_} || {} };
		1733	}
		1734	}
		1735	};
1581	};	1736	};
1582	die if $@;	1737	die if $@;
		1738
1583	&signal	1739	&signal
1584	}	1740	}
1585		1741
1586	# default implementation for ->child	1742	# default implementation for ->child
1587		1743
1588	our %PID_CB;	1744	our %PID_CB;
1589	our $CHLD_W;	1745	our $CHLD_W;
1590	our $CHLD_DELAY_W;	1746	our $CHLD_DELAY_W;
1591	our $WNOHANG;
1592		1747
		1748	# used by many Impl's
1593	sub _emit_childstatus($$) {	1749	sub _emit_childstatus($$) {
1594	my (undef, $rpid, $rstatus) = @_;	1750	my (undef, $rpid, $rstatus) = @_;
1595		1751
1596	$_->($rpid, $rstatus)	1752	$_->($rpid, $rstatus)
1597	for values %{ $PID_CB{$rpid} || {} },	1753	for values %{ $PID_CB{$rpid} || {} },
1598	values %{ $PID_CB{0} || {} };	1754	values %{ $PID_CB{0} || {} };
1599	}	1755	}
1600		1756
1601	sub _sigchld {
1602	my $pid;
1603
1604	AnyEvent->_emit_childstatus ($pid, $?)
1605	while ($pid = waitpid -1, $WNOHANG) > 0;
1606	}
1607
1608	sub child {	1757	sub child {
		1758	eval q{ # poor man's autoloading {}
		1759	*_sigchld = sub {
		1760	my $pid;
		1761
		1762	AnyEvent->_emit_childstatus ($pid, $?)
		1763	while ($pid = waitpid -1, WNOHANG) > 0;
		1764	};
		1765
		1766	*child = sub {
1609	my (undef, %arg) = @_;	1767	my (undef, %arg) = @_;
1610		1768
1611	defined (my $pid = $arg{pid} + 0)	1769	my $pid = $arg{pid};
1612	or Carp::croak "required option 'pid' is missing";	1770	my $cb = $arg{cb};
1613		1771
1614	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1772	$PID_CB{$pid}{$cb+0} = $cb;
1615		1773
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) {	1774	unless ($CHLD_W) {
1622	$CHLD_W = AE::signal CHLD => \&_sigchld;	1775	$CHLD_W = AE::signal CHLD => \&_sigchld;
1623	# child could be a zombie already, so make at least one round	1776	# child could be a zombie already, so make at least one round
1624	&_sigchld;	1777	&_sigchld;
1625	}	1778	}
1626		1779
1627	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1780	bless [$pid, $cb+0], "AnyEvent::Base::child"
1628	}	1781	};
1629		1782
1630	sub AnyEvent::Base::child::DESTROY {	1783	*AnyEvent::Base::child::DESTROY = sub {
1631	my ($pid, $cb) = @{$_[0]};	1784	my ($pid, $icb) = @{$_[0]};
1632		1785
1633	delete $PID_CB{$pid}{$cb};	1786	delete $PID_CB{$pid}{$icb};
1634	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1787	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1635		1788
1636	undef $CHLD_W unless keys %PID_CB;	1789	undef $CHLD_W unless keys %PID_CB;
		1790	};
		1791	};
		1792	die if $@;
		1793
		1794	&child
1637	}	1795	}
1638		1796
1639	# idle emulation is done by simply using a timer, regardless	1797	# idle emulation is done by simply using a timer, regardless
1640	# of whether the process is idle or not, and not letting	1798	# of whether the process is idle or not, and not letting
1641	# the callback use more than 50% of the time.	1799	# the callback use more than 50% of the time.
1642	sub idle {	1800	sub idle {
		1801	eval q{ # poor man's autoloading {}
		1802	*idle = sub {
1643	my (undef, %arg) = @_;	1803	my (undef, %arg) = @_;
1644		1804
1645	my ($cb, $w, $rcb) = $arg{cb};	1805	my ($cb, $w, $rcb) = $arg{cb};
1646		1806
1647	$rcb = sub {	1807	$rcb = sub {
1648	if ($cb) {	1808	if ($cb) {
1649	$w = _time;	1809	$w = AE::time;
1650	&$cb;	1810	&$cb;
1651	$w = _time - $w;	1811	$w = AE::time - $w;
1652		1812
1653	# never use more then 50% of the time for the idle watcher,	1813	# never use more then 50% of the time for the idle watcher,
1654	# within some limits	1814	# within some limits
1655	$w = 0.0001 if $w < 0.0001;	1815	$w = 0.0001 if $w < 0.0001;
1656	$w = 5 if $w > 5;	1816	$w = 5 if $w > 5;
1657		1817
1658	$w = AE::timer $w, 0, $rcb;	1818	$w = AE::timer $w, 0, $rcb;
1659	} else {	1819	} else {
1660	# clean up...	1820	# clean up...
1661	undef $w;	1821	undef $w;
1662	undef $rcb;	1822	undef $rcb;
		1823	}
		1824	};
		1825
		1826	$w = AE::timer 0.05, 0, $rcb;
		1827
		1828	bless \\$cb, "AnyEvent::Base::idle"
1663	}	1829	};
		1830
		1831	*AnyEvent::Base::idle::DESTROY = sub {
		1832	undef $${$_[0]};
		1833	};
1664	};	1834	};
		1835	die if $@;
1665		1836
1666	$w = AE::timer 0.05, 0, $rcb;	1837	&idle
1667
1668	bless \\$cb, "AnyEvent::Base::idle"
1669	}
1670
1671	sub AnyEvent::Base::idle::DESTROY {
1672	undef $${$_[0]};
1673	}	1838	}
1674		1839
1675	package AnyEvent::CondVar;	1840	package AnyEvent::CondVar;
1676		1841
1677	our @ISA = AnyEvent::CondVar::Base::;	1842	our @ISA = AnyEvent::CondVar::Base::;
		1843
		1844	# only to be used for subclassing
		1845	sub new {
		1846	my $class = shift;
		1847	bless AnyEvent->condvar (@_), $class
		1848	}
1678		1849
1679	package AnyEvent::CondVar::Base;	1850	package AnyEvent::CondVar::Base;
1680		1851
1681	#use overload	1852	#use overload
1682	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1853	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
…		…
1692		1863
1693	sub _send {	1864	sub _send {
1694	# nop	1865	# nop
1695	}	1866	}
1696		1867
		1868	sub _wait {
		1869	AnyEvent->_poll until $_[0]{_ae_sent};
		1870	}
		1871
1697	sub send {	1872	sub send {
1698	my $cv = shift;	1873	my $cv = shift;
1699	$cv->{_ae_sent} = [@_];	1874	$cv->{_ae_sent} = [@_];
1700	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1875	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1701	$cv->_send;	1876	$cv->_send;
…		…
1708		1883
1709	sub ready {	1884	sub ready {
1710	$_[0]{_ae_sent}	1885	$_[0]{_ae_sent}
1711	}	1886	}
1712		1887
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 {	1888	sub recv {
		1889	unless ($_[0]{_ae_sent}) {
		1890	$WAITING
		1891	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1892
		1893	local $WAITING = 1;
1723	$_[0]->_wait;	1894	$_[0]->_wait;
		1895	}
1724		1896
1725	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1897	$_[0]{_ae_croak}
1726	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1898	and Carp::croak $_[0]{_ae_croak};
		1899
		1900	wantarray
		1901	? @{ $_[0]{_ae_sent} }
		1902	: $_[0]{_ae_sent}[0]
1727	}	1903	}
1728		1904
1729	sub cb {	1905	sub cb {
1730	my $cv = shift;	1906	my $cv = shift;
1731		1907
…		…
1747	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1923	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1748	}	1924	}
1749		1925
1750	# undocumented/compatibility with pre-3.4	1926	# undocumented/compatibility with pre-3.4
1751	*broadcast = \&send;	1927	*broadcast = \&send;
1752	*wait = \&_wait;	1928	*wait = \&recv;
1753		1929
1754	=head1 ERROR AND EXCEPTION HANDLING	1930	=head1 ERROR AND EXCEPTION HANDLING
1755		1931
1756	In general, AnyEvent does not do any error handling - it relies on the	1932	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	1933	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1804	check the arguments passed to most method calls. If it finds any problems,	1980	check the arguments passed to most method calls. If it finds any problems,
1805	it will croak.	1981	it will croak.
1806		1982
1807	In other words, enables "strict" mode.	1983	In other words, enables "strict" mode.
1808		1984
1809	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	1985	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	1986	>>, it is definitely recommended to keep it off in production. Keeping
1811	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1987	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1812	can be very useful, however.	1988	can be very useful, however.
1813		1989
		1990	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		1991
		1992	If this env variable is set, then its contents will be interpreted by
		1993	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		1994	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		1995	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		1996
		1997	This takes place when the first watcher is created.
		1998
		1999	For example, to bind a debug shell on a unix domain socket in
		2000	F<< /tmp/debug<pid>.sock >>, you could use this:
		2001
		2002	PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug\$\$.sock perlprog
		2003
		2004	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2005	systems.
		2006
		2007	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2008
		2009	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2010	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2011
1814	=item C<PERL_ANYEVENT_MODEL>	2012	=item C<PERL_ANYEVENT_MODEL>
1815		2013
1816	This can be used to specify the event model to be used by AnyEvent, before	2014	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	2015	auto detection and -probing kicks in.
1818	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2016
		2017	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2018	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,	2019	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	2020	event model backend. If it fails to load then AnyEvent will proceed with
1821	auto detection and -probing.	2021	auto detection and -probing.
1822		2022
1823	This functionality might change in future versions.	2023	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2024	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2025	the end of a string designates a module name and quotes it appropriately).
1824		2026
1825	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2027	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1826	could start your program like this:	2028	could start your program like this:
1827		2029
1828	PERL_ANYEVENT_MODEL=Perl perl ...	2030	PERL_ANYEVENT_MODEL=Perl perl ...
1829		2031
1830	=item C<PERL_ANYEVENT_PROTOCOLS>	2032	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2036		2238
2037	The actual code goes further and collects all errors (C<die>s, exceptions)	2239	The actual code goes further and collects all errors (C<die>s, exceptions)
2038	that occurred during request processing. The C<result> method detects	2240	that occurred during request processing. The C<result> method detects
2039	whether an exception as thrown (it is stored inside the $txn object)	2241	whether an exception as thrown (it is stored inside the $txn object)
2040	and just throws the exception, which means connection errors and other	2242	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	2243	problems get reported to the code that tries to use the result, not in a
2042	random callback.	2244	random callback.
2043		2245
2044	All of this enables the following usage styles:	2246	All of this enables the following usage styles:
2045		2247
2046	1. Blocking:	2248	1. Blocking:
…		…
2220	(even when used without AnyEvent), but most event loops have acceptable	2422	(even when used without AnyEvent), but most event loops have acceptable
2221	performance with or without AnyEvent.	2423	performance with or without AnyEvent.
2222		2424
2223	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2425	=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	2426	the actual event loop, only with extremely fast event loops such as EV
2225	adds AnyEvent significant overhead.	2427	does AnyEvent add significant overhead.
2226		2428
2227	=item * You should avoid POE like the plague if you want performance or	2429	=item * You should avoid POE like the plague if you want performance or
2228	reasonable memory usage.	2430	reasonable memory usage.
2229		2431
2230	=back	2432	=back
…		…
2460	unless defined $SIG{PIPE};	2662	unless defined $SIG{PIPE};
2461		2663
2462	=head1 RECOMMENDED/OPTIONAL MODULES	2664	=head1 RECOMMENDED/OPTIONAL MODULES
2463		2665
2464	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2666	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.	2667	its built-in modules) are required to use it.
2466		2668
2467	That does not mean that AnyEvent won't take advantage of some additional	2669	That does not mean that AnyEvent won't take advantage of some additional
2468	modules if they are installed.	2670	modules if they are installed.
2469		2671
2470	This section explains which additional modules will be used, and how they	2672	This section explains which additional modules will be used, and how they
…		…
2503	automatic timer adjustments even when no monotonic clock is available,	2705	automatic timer adjustments even when no monotonic clock is available,
2504	can take avdantage of advanced kernel interfaces such as C<epoll> and	2706	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	2707	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>).	2708	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2507		2709
		2710	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2711	then this module will do nothing for you.
		2712
2508	=item L<Guard>	2713	=item L<Guard>
2509		2714
2510	The guard module, when used, will be used to implement	2715	The guard module, when used, will be used to implement
2511	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2716	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	2717	lot less memory), but otherwise doesn't affect guard operation much. It is
2513	purely used for performance.	2718	purely used for performance.
2514		2719
2515	=item L<JSON> and L<JSON::XS>	2720	=item L<JSON> and L<JSON::XS>
2516		2721
2517	One of these modules is required when you want to read or write JSON data	2722	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	2723	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.	2724	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		2725
2524	=item L<Net::SSLeay>	2726	=item L<Net::SSLeay>
2525		2727
2526	Implementing TLS/SSL in Perl is certainly interesting, but not very	2728	Implementing TLS/SSL in Perl is certainly interesting, but not very
2527	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2729	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.	2730	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2529		2731
2530	=item L<Time::HiRes>	2732	=item L<Time::HiRes>
2531		2733
2532	This module is part of perl since release 5.008. It will be used when the	2734	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	2735	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	2736	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2535	try to use a monotonic clock for timing stability.	2737	try to use a monotonic clock for timing stability.
2536		2738
2537	=back	2739	=back
2538		2740
2539		2741
…		…
2601	pronounced).	2803	pronounced).
2602		2804
2603		2805
2604	=head1 SEE ALSO	2806	=head1 SEE ALSO
2605		2807
		2808	Tutorial/Introduction: L<AnyEvent::Intro>.
		2809
		2810	FAQ: L<AnyEvent::FAQ>.
		2811
2606	Utility functions: L<AnyEvent::Util>.	2812	Utility functions: L<AnyEvent::Util>.
2607		2813
2608	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2814	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2609	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2815	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2610		2816
2611	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2817	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2612	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2818	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2613	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2819	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2614	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2820	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
…		…
2616	Non-blocking file handles, sockets, TCP clients and	2822	Non-blocking file handles, sockets, TCP clients and
2617	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2823	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2618		2824
2619	Asynchronous DNS: L<AnyEvent::DNS>.	2825	Asynchronous DNS: L<AnyEvent::DNS>.
2620		2826
2621	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2827	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2622	L<Coro::Event>,
2623		2828
2624	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2829	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2625	L<AnyEvent::HTTP>.	2830	L<AnyEvent::HTTP>.
2626		2831
2627		2832
2628	=head1 AUTHOR	2833	=head1 AUTHOR
2629		2834

Diff Legend

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