ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.313 by root, Sun Feb 21 09:28:18 2010 UTC vs.
Revision 1.358 by root, Sat Aug 13 02:35:32 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.
922		938
923	If you need to do some initialisation before AnyEvent watchers are	939	If you need to do some initialisation before AnyEvent watchers are
924	created, use C<post_detect>.	940	created, use C<post_detect>.
925		941
926	=item $guard = AnyEvent::post_detect { BLOCK }	942	=item $guard = AnyEvent::post_detect { BLOCK }
927		943
928	Arranges for the code block to be executed as soon as the event model is	944	Arranges for the code block to be executed as soon as the event model is
929	autodetected (or immediately if this has already happened).	945	autodetected (or immediately if that has already happened).
930		946
931	The block will be executed I<after> the actual backend has been detected	947	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	948	(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	949	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	950	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
943	that automatically removes the callback again when it is destroyed (or	959	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	960	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
945	a case where this is useful.	961	a case where this is useful.
946		962
947	Example: Create a watcher for the IO::AIO module and store it in	963	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.	964	C<$WATCHER>, but do so only do so after the event loop is initialised.
949		965
950	our WATCHER;	966	our WATCHER;
951		967
952	my $guard = AnyEvent::post_detect {	968	my $guard = AnyEvent::post_detect {
953	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	969	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
961	$WATCHER ||= $guard;	977	$WATCHER ||= $guard;
962		978
963	=item @AnyEvent::post_detect	979	=item @AnyEvent::post_detect
964		980
965	If there are any code references in this array (you can C<push> to it	981	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	982	before or after loading AnyEvent), then they will be called directly
967	the event loop has been chosen.	983	after the event loop has been chosen.
968		984
969	You should check C<$AnyEvent::MODEL> before adding to this array, though:	985	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	986	if it is defined then the event loop has already been detected, and the
971	array will be ignored.	987	array will be ignored.
972		988
…		…
989	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
990	# as soon as it is	1006	# as soon as it is
991	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
992	}	1008	}
993		1009
		1010	=item AnyEvent::postpone { BLOCK }
		1011
		1012	Arranges for the block to be executed as soon as possible, but not before
		1013	the call itself returns. In practise, the block will be executed just
		1014	before the event loop polls for new events, or shortly afterwards.
		1015
		1016	This function never returns anything (to make the C<return postpone { ...
		1017	}> idiom more useful.
		1018
		1019	To understand the usefulness of this function, consider a function that
		1020	asynchronously does something for you and returns some transaction
		1021	object or guard to let you cancel the operation. For example,
		1022	C<AnyEvent::Socket::tcp_connect>:
		1023
		1024	# start a conenction attempt unless one is active
		1025	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1026	delete $self->{connect_guard};
		1027	...
		1028	};
		1029
		1030	Imagine that this function could instantly call the callback, for
		1031	example, because it detects an obvious error such as a negative port
		1032	number. Invoking the callback before the function returns causes problems
		1033	however: the callback will be called and will try to delete the guard
		1034	object. But since the function hasn't returned yet, there is nothing to
		1035	delete. When the function eventually returns it will assign the guard
		1036	object to C<< $self->{connect_guard} >>, where it will likely never be
		1037	deleted, so the program thinks it is still trying to connect.
		1038
		1039	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1040	callback directly on error:
		1041
		1042	$cb->(undef), return # signal error to callback, BAD!
		1043	if $some_error_condition;
		1044
		1045	It should use C<postpone>:
		1046
		1047	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1048	if $some_error_condition;
		1049
994	=back	1050	=back
995		1051
996	=head1 WHAT TO DO IN A MODULE	1052	=head1 WHAT TO DO IN A MODULE
997		1053
998	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1054	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	1064	because it will stall the whole program, and the whole point of using
1009	events is to stay interactive.	1065	events is to stay interactive.
1010		1066
1011	It is fine, however, to call C<< ->recv >> when the user of your module	1067	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	1068	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 >>	1069	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).	1070	freely, as the user of your module knows what she is doing. Always).
1015		1071
1016	=head1 WHAT TO DO IN THE MAIN PROGRAM	1072	=head1 WHAT TO DO IN THE MAIN PROGRAM
1017		1073
1018	There will always be a single main program - the only place that should	1074	There will always be a single main program - the only place that should
1019	dictate which event model to use.	1075	dictate which event model to use.
1020		1076
1021	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1077	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	1078	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.	1079	uses AnyEvent, but does not care which event loop is used, all it needs
		1080	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1081	available loop implementation.
1024		1082
1025	If the main program relies on a specific event model - for example, in	1083	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	1084	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	1085	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	1086	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	1087	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	1088	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.	1089	might choose the wrong one unless you load the correct one yourself.
1032		1090
1033	You can chose to use a pure-perl implementation by loading the	1091	You can chose to use a pure-perl implementation by loading the
1034	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1092	C<AnyEvent::Loop> module, which gives you similar behaviour
1035	everywhere, but letting AnyEvent chose the model is generally better.	1093	everywhere, but letting AnyEvent chose the model is generally better.
1036		1094
1037	=head2 MAINLOOP EMULATION	1095	=head2 MAINLOOP EMULATION
1038		1096
1039	Sometimes (often for short test scripts, or even standalone programs who	1097	Sometimes (often for short test scripts, or even standalone programs who
…		…
1054	=head1 OTHER MODULES	1112	=head1 OTHER MODULES
1055		1113
1056	The following is a non-exhaustive list of additional modules that use	1114	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	1115	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	1116	modules and other event loops in the same program. Some of the modules
1059	come with AnyEvent, most are available via CPAN.	1117	come as part of AnyEvent, the others are available via CPAN.
1060		1118
1061	=over 4	1119	=over 4
1062		1120
1063	=item L<AnyEvent::Util>	1121	=item L<AnyEvent::Util>
1064		1122
1065	Contains various utility functions that replace often-used but blocking	1123	Contains various utility functions that replace often-used blocking
1066	functions such as C<inet_aton> by event-/callback-based versions.	1124	functions such as C<inet_aton> with event/callback-based versions.
1067		1125
1068	=item L<AnyEvent::Socket>	1126	=item L<AnyEvent::Socket>
1069		1127
1070	Provides various utility functions for (internet protocol) sockets,	1128	Provides various utility functions for (internet protocol) sockets,
1071	addresses and name resolution. Also functions to create non-blocking tcp	1129	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1073		1131
1074	=item L<AnyEvent::Handle>	1132	=item L<AnyEvent::Handle>
1075		1133
1076	Provide read and write buffers, manages watchers for reads and writes,	1134	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	1135	supports raw and formatted I/O, I/O queued and fully transparent and
1078	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1136	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1079		1137
1080	=item L<AnyEvent::DNS>	1138	=item L<AnyEvent::DNS>
1081		1139
1082	Provides rich asynchronous DNS resolver capabilities.	1140	Provides rich asynchronous DNS resolver capabilities.
1083		1141
		1142	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1143
		1144	Implement event-based interfaces to the protocols of the same name (for
		1145	the curious, IGS is the International Go Server and FCP is the Freenet
		1146	Client Protocol).
		1147
		1148	=item L<AnyEvent::Handle::UDP>
		1149
		1150	Here be danger!
		1151
		1152	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1153	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1154	its use of a stream-based API with a protocol that isn't streamable, that
		1155	the only way to improve it is to delete it.
		1156
		1157	It features data corruption (but typically only under load) and general
		1158	confusion. On top, the author is not only clueless about UDP but also
		1159	fact-resistant - some gems of his understanding: "connect doesn't work
		1160	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1161	packets", "I don't need to implement proper error checking as UDP doesn't
		1162	support error checking" and so on - he doesn't even understand what's
		1163	wrong with his module when it is explained to him.
		1164
1084	=item L<AnyEvent::HTTP>	1165	=item L<AnyEvent::DBI>
1085		1166
1086	A simple-to-use HTTP library that is capable of making a lot of concurrent	1167	Executes L<DBI> requests asynchronously in a proxy process for you,
1087	HTTP requests.	1168	notifying you in an event-based way when the operation is finished.
		1169
		1170	=item L<AnyEvent::AIO>
		1171
		1172	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1173	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1174	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1175	file I/O, and much more.
1088		1176
1089	=item L<AnyEvent::HTTPD>	1177	=item L<AnyEvent::HTTPD>
1090		1178
1091	Provides a simple web application server framework.	1179	A simple embedded webserver.
1092		1180
1093	=item L<AnyEvent::FastPing>	1181	=item L<AnyEvent::FastPing>
1094		1182
1095	The fastest ping in the west.	1183	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		1184
1139	=item L<Coro>	1185	=item L<Coro>
1140		1186
1141	Has special support for AnyEvent via L<Coro::AnyEvent>.	1187	Has special support for AnyEvent via L<Coro::AnyEvent>.
1142		1188
…		…
1146		1192
1147	package AnyEvent;	1193	package AnyEvent;
1148		1194
1149	# basically a tuned-down version of common::sense	1195	# basically a tuned-down version of common::sense
1150	sub common_sense {	1196	sub common_sense {
1151	# from common:.sense 1.0	1197	# from common:.sense 3.4
1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1198	${^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)	1199	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1154	$^H |= 0x00000600;	1200	$^H |= 0x00000600;
1155	}	1201	}
1156		1202
1157	BEGIN { AnyEvent::common_sense }	1203	BEGIN { AnyEvent::common_sense }
1158		1204
1159	use Carp ();	1205	use Carp ();
1160		1206
1161	our $VERSION = '5.24';	1207	our $VERSION = '5.34';
1162	our $MODEL;	1208	our $MODEL;
1163		1209
1164	our $AUTOLOAD;
1165	our @ISA;	1210	our @ISA;
1166		1211
1167	our @REGISTRY;	1212	our @REGISTRY;
1168		1213
1169	our $VERBOSE;	1214	our $VERBOSE;
1170		1215
1171	BEGIN {	1216	BEGIN {
1172	require "AnyEvent/constants.pl";	1217	require "AnyEvent/constants.pl";
1173		1218
1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";	1219	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1175		1220
1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1221	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1177	if ${^TAINT};	1222	if ${^TAINT};
1178		1223
1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1224	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1189	$PROTOCOL{$_} = ++$idx	1234	$PROTOCOL{$_} = ++$idx
1190	for reverse split /\s*,\s*/,	1235	for reverse split /\s*,\s*/,
1191	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1236	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1192	}	1237	}
1193		1238
		1239	our @post_detect;
		1240
		1241	sub post_detect(&) {
		1242	my ($cb) = @_;
		1243
		1244	push @post_detect, $cb;
		1245
		1246	defined wantarray
		1247	? bless \$cb, "AnyEvent::Util::postdetect"
		1248	: ()
		1249	}
		1250
		1251	sub AnyEvent::Util::postdetect::DESTROY {
		1252	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1253	}
		1254
		1255	our $POSTPONE_W;
		1256	our @POSTPONE;
		1257
		1258	sub _postpone_exec {
		1259	undef $POSTPONE_W;
		1260
		1261	&{ shift @POSTPONE }
		1262	while @POSTPONE;
		1263	}
		1264
		1265	sub postpone(&) {
		1266	push @POSTPONE, shift;
		1267
		1268	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1269
		1270	()
		1271	}
		1272
1194	my @models = (	1273	our @models = (
1195	[EV:: => AnyEvent::Impl::EV:: , 1],	1274	[EV:: => AnyEvent::Impl::EV:: , 1],
1196	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1275	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1197	# everything below here will not (normally) be autoprobed	1276	# everything below here will not (normally) be autoprobed
1198	# as the pureperl backend should work everywhere	1277	# as the pure perl backend should work everywhere
1199	# and is usually faster	1278	# and is usually faster
1200	[Event:: => AnyEvent::Impl::Event::, 1],	1279	[Event:: => AnyEvent::Impl::Event::, 1],
1201	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1280	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1202	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1281	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1203	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1282	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1204	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1283	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1205	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1284	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1206	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1285	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1207	[Wx:: => AnyEvent::Impl::POE::],	1286	[Wx:: => AnyEvent::Impl::POE::],
1208	[Prima:: => AnyEvent::Impl::POE::],	1287	[Prima:: => AnyEvent::Impl::POE::],
1209	# IO::Async is just too broken - we would need workarounds for its	1288	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1210	# byzantine signal and broken child handling, among others.	1289	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1211	# IO::Async is rather hard to detect, as it doesn't have any	1290	[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	);	1291	);
1218		1292
1219	our %method = map +($_ => 1),	1293	# all autoloaded methods reserve the complete glob, not just the method slot.
		1294	# due to bugs in perls method cache implementation.
1220	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1295	our @methods = qw(io timer time now now_update signal child idle condvar);
1221
1222	our @post_detect;
1223
1224	sub post_detect(&) {
1225	my ($cb) = @_;
1226
1227	if ($MODEL) {
1228	$cb->();
1229
1230	undef
1231	} else {
1232	push @post_detect, $cb;
1233
1234	defined wantarray
1235	? bless \$cb, "AnyEvent::Util::postdetect"
1236	: ()
1237	}
1238	}
1239
1240	sub AnyEvent::Util::postdetect::DESTROY {
1241	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1242	}
1243		1296
1244	sub detect() {	1297	sub detect() {
		1298	local $!; # for good measure
		1299	local $SIG{__DIE__}; # we use eval
		1300
1245	# free some memory	1301	# free some memory
1246	*detect = sub () { $MODEL };	1302	*detect = sub () { $MODEL };
		1303	# undef &func doesn't correctly update the method cache. grmbl.
		1304	# so we delete the whole glob. grmbl.
		1305	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1306	# a glob with an active sub. hrm. i hope it works, but perl is
		1307	# usually buggy in this department. sigh.
		1308	delete @{"AnyEvent::"}{@methods};
		1309	undef @methods;
1247		1310
1248	local $!; # for good measure
1249	local $SIG{__DIE__};
1250
1251	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1311	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1252	my $model = "AnyEvent::Impl::$1";	1312	my $model = $1;
		1313	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1253	if (eval "require $model") {	1314	if (eval "require $model") {
1254	$MODEL = $model;	1315	$MODEL = $model;
1255	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1316	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1256	} else {	1317	} else {
1257	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1318	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
…		…
1286	last;	1347	last;
1287	}	1348	}
1288	}	1349	}
1289		1350
1290	$MODEL	1351	$MODEL
1291	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1352	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1292	}	1353	}
1293	}	1354	}
1294		1355
1295	@models = (); # free probe data	1356	# free memory only needed for probing
		1357	undef @models;
		1358	undef @REGISTRY;
1296		1359
1297	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1360	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1298	unshift @ISA, $MODEL;	1361	unshift @ISA, $MODEL;
1299		1362
1300	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1363	# now nuke some methods that are overridden by the backend.
		1364	# SUPER usage is not allowed in these.
		1365	for (qw(time signal child idle)) {
		1366	undef &{"AnyEvent::Base::$_"}
		1367	if defined &{"$MODEL\::$_"};
		1368	}
		1369
		1370	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1371	require AnyEvent::Strict;
		1372	}
		1373
		1374	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1375	require AnyEvent::Debug;
		1376	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1377	}
		1378
		1379	if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1380	require AnyEvent::Socket;
		1381	require AnyEvent::Debug;
		1382
		1383	my ($host, $service) = AnyEvent::Socket::parse_hostport ($ENV{PERL_ANYEVENT_DEBUG_SHELL});
		1384	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1385	}
1301		1386
1302	(shift @post_detect)->() while @post_detect;	1387	(shift @post_detect)->() while @post_detect;
		1388	undef @post_detect;
		1389
		1390	*post_detect = sub(&) {
		1391	shift->();
		1392
		1393	undef
		1394	};
1303		1395
1304	$MODEL	1396	$MODEL
1305	}	1397	}
1306		1398
1307	sub AUTOLOAD {	1399	for my $name (@methods) {
1308	(my $func = $AUTOLOAD) =~ s/.*://;	1400	*$name = sub {
1309
1310	$method{$func}
1311	or Carp::croak "$func: not a valid AnyEvent class method";
1312
1313	detect;	1401	detect;
1314		1402	# we use goto because
1315	my $class = shift;	1403	# a) it makes the thunk more transparent
1316	$class->$func (@_);	1404	# b) it allows us to delete the thunk later
		1405	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1406	};
1317	}	1407	}
1318		1408
1319	# utility function to dup a filehandle. this is used by many backends	1409	# utility function to dup a filehandle. this is used by many backends
1320	# to support binding more than one watcher per filehandle (they usually	1410	# to support binding more than one watcher per filehandle (they usually
1321	# allow only one watcher per fd, so we dup it to get a different one).	1411	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1335		1425
1336	=head1 SIMPLIFIED AE API	1426	=head1 SIMPLIFIED AE API
1337		1427
1338	Starting with version 5.0, AnyEvent officially supports a second, much	1428	Starting with version 5.0, AnyEvent officially supports a second, much
1339	simpler, API that is designed to reduce the calling, typing and memory	1429	simpler, API that is designed to reduce the calling, typing and memory
1340	overhead.	1430	overhead by using function call syntax and a fixed number of parameters.
1341		1431
1342	See the L<AE> manpage for details.	1432	See the L<AE> manpage for details.
1343		1433
1344	=cut	1434	=cut
1345		1435
1346	package AE;	1436	package AE;
1347		1437
1348	our $VERSION = $AnyEvent::VERSION;	1438	our $VERSION = $AnyEvent::VERSION;
1349		1439
		1440	sub _reset() {
		1441	eval q{
		1442	# fall back to the main API by default - backends and AnyEvent::Base
		1443	# implementations can overwrite these.
		1444
1350	sub io($$$) {	1445	sub io($$$) {
1351	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1446	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1352	}	1447	}
1353		1448
1354	sub timer($$$) {	1449	sub timer($$$) {
1355	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1450	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1356	}	1451	}
1357		1452
1358	sub signal($$) {	1453	sub signal($$) {
1359	AnyEvent->signal (signal => $_[0], cb => $_[1])	1454	AnyEvent->signal (signal => $_[0], cb => $_[1])
1360	}	1455	}
1361		1456
1362	sub child($$) {	1457	sub child($$) {
1363	AnyEvent->child (pid => $_[0], cb => $_[1])	1458	AnyEvent->child (pid => $_[0], cb => $_[1])
1364	}	1459	}
1365		1460
1366	sub idle($) {	1461	sub idle($) {
1367	AnyEvent->idle (cb => $_[0])	1462	AnyEvent->idle (cb => $_[0]);
1368	}	1463	}
1369		1464
1370	sub cv(;&) {	1465	sub cv(;&) {
1371	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1466	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1372	}	1467	}
1373		1468
1374	sub now() {	1469	sub now() {
1375	AnyEvent->now	1470	AnyEvent->now
1376	}	1471	}
1377		1472
1378	sub now_update() {	1473	sub now_update() {
1379	AnyEvent->now_update	1474	AnyEvent->now_update
1380	}	1475	}
1381		1476
1382	sub time() {	1477	sub time() {
1383	AnyEvent->time	1478	AnyEvent->time
		1479	}
		1480
		1481	*postpone = \&AnyEvent::postpone;
		1482	};
		1483	die if $@;
1384	}	1484	}
		1485
		1486	BEGIN { _reset }
1385		1487
1386	package AnyEvent::Base;	1488	package AnyEvent::Base;
1387		1489
1388	# default implementations for many methods	1490	# default implementations for many methods
1389		1491
1390	sub _time() {	1492	sub time {
1391	eval q{ # poor man's autoloading	1493	eval q{ # poor man's autoloading {}
1392	# probe for availability of Time::HiRes	1494	# probe for availability of Time::HiRes
1393	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1495	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1394	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1496	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1395	*_time = \&Time::HiRes::time;	1497	*AE::time = \&Time::HiRes::time;
1396	# if (eval "use POSIX (); (POSIX::times())...	1498	# if (eval "use POSIX (); (POSIX::times())...
1397	} else {	1499	} else {
1398	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1500	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1399	*_time = sub (){ time }; # epic fail	1501	*AE::time = sub (){ time }; # epic fail
1400	}	1502	}
		1503
		1504	*time = sub { AE::time }; # different prototypes
1401	};	1505	};
1402	die if $@;	1506	die if $@;
1403		1507
1404	&_time	1508	&time
1405	}	1509	}
1406		1510
1407	sub time { _time }	1511	*now = \&time;
1408	sub now { _time }	1512
1409	sub now_update { }	1513	sub now_update { }
1410		1514
		1515	sub _poll {
		1516	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1517	}
		1518
1411	# default implementation for ->condvar	1519	# default implementation for ->condvar
		1520	# in fact, the default should not be overwritten
1412		1521
1413	sub condvar {	1522	sub condvar {
		1523	eval q{ # poor man's autoloading {}
		1524	*condvar = sub {
1414	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1525	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1526	};
		1527
		1528	*AE::cv = sub (;&) {
		1529	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1530	};
		1531	};
		1532	die if $@;
		1533
		1534	&condvar
1415	}	1535	}
1416		1536
1417	# default implementation for ->signal	1537	# default implementation for ->signal
1418		1538
1419	our $HAVE_ASYNC_INTERRUPT;	1539	our $HAVE_ASYNC_INTERRUPT;
…		…
1449	undef $SIG_TW	1569	undef $SIG_TW
1450	unless --$SIG_COUNT;	1570	unless --$SIG_COUNT;
1451	}	1571	}
1452		1572
1453	our $_sig_name_init; $_sig_name_init = sub {	1573	our $_sig_name_init; $_sig_name_init = sub {
1454	eval q{ # poor man's autoloading	1574	eval q{ # poor man's autoloading {}
1455	undef $_sig_name_init;	1575	undef $_sig_name_init;
1456		1576
1457	if (_have_async_interrupt) {	1577	if (_have_async_interrupt) {
1458	*sig2num = \&Async::Interrupt::sig2num;	1578	*sig2num = \&Async::Interrupt::sig2num;
1459	*sig2name = \&Async::Interrupt::sig2name;	1579	*sig2name = \&Async::Interrupt::sig2name;
…		…
1513	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1633	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1514		1634
1515	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1635	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1516	}	1636	}
1517		1637
1518	*signal = sub {	1638	*signal = $HAVE_ASYNC_INTERRUPT
		1639	? sub {
1519	my (undef, %arg) = @_;	1640	my (undef, %arg) = @_;
1520		1641
1521	my $signal = uc $arg{signal}
1522	or Carp::croak "required option 'signal' is missing";
1523
1524	if ($HAVE_ASYNC_INTERRUPT) {
1525	# async::interrupt	1642	# async::interrupt
1526
1527	$signal = sig2num $signal;	1643	my $signal = sig2num $arg{signal};
1528	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1644	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1529		1645
1530	$SIG_ASY{$signal} ||= new Async::Interrupt	1646	$SIG_ASY{$signal} ||= new Async::Interrupt
1531	cb => sub { undef $SIG_EV{$signal} },	1647	cb => sub { undef $SIG_EV{$signal} },
1532	signal => $signal,	1648	signal => $signal,
1533	pipe => [$SIGPIPE_R->filenos],	1649	pipe => [$SIGPIPE_R->filenos],
1534	pipe_autodrain => 0,	1650	pipe_autodrain => 0,
1535	;	1651	;
1536		1652
1537	} else {	1653	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1654	}
		1655	: sub {
		1656	my (undef, %arg) = @_;
		1657
1538	# pure perl	1658	# pure perl
1539
1540	# AE::Util has been loaded in signal
1541	$signal = sig2name $signal;	1659	my $signal = sig2name $arg{signal};
1542	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1660	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1543		1661
1544	$SIG{$signal} ||= sub {	1662	$SIG{$signal} ||= sub {
1545	local $!;	1663	local $!;
1546	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1664	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1547	undef $SIG_EV{$signal};	1665	undef $SIG_EV{$signal};
1548	};	1666	};
1549		1667
1550	# can't do signal processing without introducing races in pure perl,	1668	# can't do signal processing without introducing races in pure perl,
1551	# so limit the signal latency.	1669	# so limit the signal latency.
1552	_sig_add;	1670	_sig_add;
1553	}
1554		1671
1555	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1672	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1673	}
1556	};	1674	;
1557		1675
1558	*AnyEvent::Base::signal::DESTROY = sub {	1676	*AnyEvent::Base::signal::DESTROY = sub {
1559	my ($signal, $cb) = @{$_[0]};	1677	my ($signal, $cb) = @{$_[0]};
1560		1678
1561	_sig_del;	1679	_sig_del;
…		…
1577	: sysread $SIGPIPE_R, (my $dummy), 9;	1695	: sysread $SIGPIPE_R, (my $dummy), 9;
1578		1696
1579	while (%SIG_EV) {	1697	while (%SIG_EV) {
1580	for (keys %SIG_EV) {	1698	for (keys %SIG_EV) {
1581	delete $SIG_EV{$_};	1699	delete $SIG_EV{$_};
1582	$_->() for values %{ $SIG_CB{$_} || {} };	1700	&$_ for values %{ $SIG_CB{$_} || {} };
1583	}	1701	}
1584	}	1702	}
1585	};	1703	};
1586	};	1704	};
1587	die if $@;	1705	die if $@;
…		…
1592	# default implementation for ->child	1710	# default implementation for ->child
1593		1711
1594	our %PID_CB;	1712	our %PID_CB;
1595	our $CHLD_W;	1713	our $CHLD_W;
1596	our $CHLD_DELAY_W;	1714	our $CHLD_DELAY_W;
1597	our $WNOHANG;
1598		1715
1599	# used by many Impl's	1716	# used by many Impl's
1600	sub _emit_childstatus($$) {	1717	sub _emit_childstatus($$) {
1601	my (undef, $rpid, $rstatus) = @_;	1718	my (undef, $rpid, $rstatus) = @_;
1602		1719
…		…
1609	eval q{ # poor man's autoloading {}	1726	eval q{ # poor man's autoloading {}
1610	*_sigchld = sub {	1727	*_sigchld = sub {
1611	my $pid;	1728	my $pid;
1612		1729
1613	AnyEvent->_emit_childstatus ($pid, $?)	1730	AnyEvent->_emit_childstatus ($pid, $?)
1614	while ($pid = waitpid -1, $WNOHANG) > 0;	1731	while ($pid = waitpid -1, WNOHANG) > 0;
1615	};	1732	};
1616		1733
1617	*child = sub {	1734	*child = sub {
1618	my (undef, %arg) = @_;	1735	my (undef, %arg) = @_;
1619		1736
1620	defined (my $pid = $arg{pid} + 0)	1737	my $pid = $arg{pid};
1621	or Carp::croak "required option 'pid' is missing";	1738	my $cb = $arg{cb};
1622		1739
1623	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1740	$PID_CB{$pid}{$cb+0} = $cb;
1624
1625	# WNOHANG is almost cetrainly 1 everywhere
1626	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1627	? 1
1628	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1629		1741
1630	unless ($CHLD_W) {	1742	unless ($CHLD_W) {
1631	$CHLD_W = AE::signal CHLD => \&_sigchld;	1743	$CHLD_W = AE::signal CHLD => \&_sigchld;
1632	# child could be a zombie already, so make at least one round	1744	# child could be a zombie already, so make at least one round
1633	&_sigchld;	1745	&_sigchld;
1634	}	1746	}
1635		1747
1636	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1748	bless [$pid, $cb+0], "AnyEvent::Base::child"
1637	};	1749	};
1638		1750
1639	*AnyEvent::Base::child::DESTROY = sub {	1751	*AnyEvent::Base::child::DESTROY = sub {
1640	my ($pid, $cb) = @{$_[0]};	1752	my ($pid, $icb) = @{$_[0]};
1641		1753
1642	delete $PID_CB{$pid}{$cb};	1754	delete $PID_CB{$pid}{$icb};
1643	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1755	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1644		1756
1645	undef $CHLD_W unless keys %PID_CB;	1757	undef $CHLD_W unless keys %PID_CB;
1646	};	1758	};
1647	};	1759	};
…		…
1660		1772
1661	my ($cb, $w, $rcb) = $arg{cb};	1773	my ($cb, $w, $rcb) = $arg{cb};
1662		1774
1663	$rcb = sub {	1775	$rcb = sub {
1664	if ($cb) {	1776	if ($cb) {
1665	$w = _time;	1777	$w = AE::time;
1666	&$cb;	1778	&$cb;
1667	$w = _time - $w;	1779	$w = AE::time - $w;
1668		1780
1669	# never use more then 50% of the time for the idle watcher,	1781	# never use more then 50% of the time for the idle watcher,
1670	# within some limits	1782	# within some limits
1671	$w = 0.0001 if $w < 0.0001;	1783	$w = 0.0001 if $w < 0.0001;
1672	$w = 5 if $w > 5;	1784	$w = 5 if $w > 5;
…		…
1695		1807
1696	package AnyEvent::CondVar;	1808	package AnyEvent::CondVar;
1697		1809
1698	our @ISA = AnyEvent::CondVar::Base::;	1810	our @ISA = AnyEvent::CondVar::Base::;
1699		1811
		1812	# only to be used for subclassing
		1813	sub new {
		1814	my $class = shift;
		1815	bless AnyEvent->condvar (@_), $class
		1816	}
		1817
1700	package AnyEvent::CondVar::Base;	1818	package AnyEvent::CondVar::Base;
1701		1819
1702	#use overload	1820	#use overload
1703	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1821	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1704	# fallback => 1;	1822	# fallback => 1;
…		…
1713		1831
1714	sub _send {	1832	sub _send {
1715	# nop	1833	# nop
1716	}	1834	}
1717		1835
		1836	sub _wait {
		1837	AnyEvent->_poll until $_[0]{_ae_sent};
		1838	}
		1839
1718	sub send {	1840	sub send {
1719	my $cv = shift;	1841	my $cv = shift;
1720	$cv->{_ae_sent} = [@_];	1842	$cv->{_ae_sent} = [@_];
1721	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1843	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1722	$cv->_send;	1844	$cv->_send;
…		…
1729		1851
1730	sub ready {	1852	sub ready {
1731	$_[0]{_ae_sent}	1853	$_[0]{_ae_sent}
1732	}	1854	}
1733		1855
1734	sub _wait {
1735	$WAITING
1736	and !$_[0]{_ae_sent}
1737	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1738
1739	local $WAITING = 1;
1740	AnyEvent->one_event while !$_[0]{_ae_sent};
1741	}
1742
1743	sub recv {	1856	sub recv {
		1857	unless ($_[0]{_ae_sent}) {
		1858	$WAITING
		1859	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1860
		1861	local $WAITING = 1;
1744	$_[0]->_wait;	1862	$_[0]->_wait;
		1863	}
1745		1864
1746	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1865	$_[0]{_ae_croak}
1747	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1866	and Carp::croak $_[0]{_ae_croak};
		1867
		1868	wantarray
		1869	? @{ $_[0]{_ae_sent} }
		1870	: $_[0]{_ae_sent}[0]
1748	}	1871	}
1749		1872
1750	sub cb {	1873	sub cb {
1751	my $cv = shift;	1874	my $cv = shift;
1752		1875
…		…
1768	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1891	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1769	}	1892	}
1770		1893
1771	# undocumented/compatibility with pre-3.4	1894	# undocumented/compatibility with pre-3.4
1772	*broadcast = \&send;	1895	*broadcast = \&send;
1773	*wait = \&_wait;	1896	*wait = \&recv;
1774		1897
1775	=head1 ERROR AND EXCEPTION HANDLING	1898	=head1 ERROR AND EXCEPTION HANDLING
1776		1899
1777	In general, AnyEvent does not do any error handling - it relies on the	1900	In general, AnyEvent does not do any error handling - it relies on the
1778	caller to do that if required. The L<AnyEvent::Strict> module (see also	1901	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1825	check the arguments passed to most method calls. If it finds any problems,	1948	check the arguments passed to most method calls. If it finds any problems,
1826	it will croak.	1949	it will croak.
1827		1950
1828	In other words, enables "strict" mode.	1951	In other words, enables "strict" mode.
1829		1952
1830	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	1953	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1831	>>, it is definitely recommended to keep it off in production. Keeping	1954	>>, it is definitely recommended to keep it off in production. Keeping
1832	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1955	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1833	can be very useful, however.	1956	can be very useful, however.
1834		1957
		1958	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		1959
		1960	If this env variable is set, then its contents will be
		1961	interpreted by C<AnyEvent::Socket::parse_hostport> and an
		1962	C<AnyEvent::Debug::shell> is bound on that port. The shell object is saved
		1963	in C<$AnyEvent::Debug::SHELL>.
		1964
		1965	For example, to bind a debug shell on a unix domain socket in
		1966	F</tmp/debug.sock>, you could use this:
		1967
		1968	PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug.sock perlprog
		1969
		1970	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		1971
		1972	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		1973	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		1974
1835	=item C<PERL_ANYEVENT_MODEL>	1975	=item C<PERL_ANYEVENT_MODEL>
1836		1976
1837	This can be used to specify the event model to be used by AnyEvent, before	1977	This can be used to specify the event model to be used by AnyEvent, before
1838	auto detection and -probing kicks in. It must be a string consisting	1978	auto detection and -probing kicks in.
1839	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1979
		1980	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		1981	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1840	and the resulting module name is loaded and if the load was successful,	1982	resulting module name is loaded and - if the load was successful - used as
1841	used as event model. If it fails to load AnyEvent will proceed with	1983	event model backend. If it fails to load then AnyEvent will proceed with
1842	auto detection and -probing.	1984	auto detection and -probing.
1843		1985
1844	This functionality might change in future versions.	1986	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		1987	nothing gets prepended and the module name is used as-is (hint: C<::> at
		1988	the end of a string designates a module name and quotes it appropriately).
1845		1989
1846	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1990	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1847	could start your program like this:	1991	could start your program like this:
1848		1992
1849	PERL_ANYEVENT_MODEL=Perl perl ...	1993	PERL_ANYEVENT_MODEL=Perl perl ...
1850		1994
1851	=item C<PERL_ANYEVENT_PROTOCOLS>	1995	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2057		2201
2058	The actual code goes further and collects all errors (C<die>s, exceptions)	2202	The actual code goes further and collects all errors (C<die>s, exceptions)
2059	that occurred during request processing. The C<result> method detects	2203	that occurred during request processing. The C<result> method detects
2060	whether an exception as thrown (it is stored inside the $txn object)	2204	whether an exception as thrown (it is stored inside the $txn object)
2061	and just throws the exception, which means connection errors and other	2205	and just throws the exception, which means connection errors and other
2062	problems get reported tot he code that tries to use the result, not in a	2206	problems get reported to the code that tries to use the result, not in a
2063	random callback.	2207	random callback.
2064		2208
2065	All of this enables the following usage styles:	2209	All of this enables the following usage styles:
2066		2210
2067	1. Blocking:	2211	1. Blocking:
…		…
2481	unless defined $SIG{PIPE};	2625	unless defined $SIG{PIPE};
2482		2626
2483	=head1 RECOMMENDED/OPTIONAL MODULES	2627	=head1 RECOMMENDED/OPTIONAL MODULES
2484		2628
2485	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2629	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2486	it's built-in modules) are required to use it.	2630	its built-in modules) are required to use it.
2487		2631
2488	That does not mean that AnyEvent won't take advantage of some additional	2632	That does not mean that AnyEvent won't take advantage of some additional
2489	modules if they are installed.	2633	modules if they are installed.
2490		2634
2491	This section explains which additional modules will be used, and how they	2635	This section explains which additional modules will be used, and how they
…		…
2524	automatic timer adjustments even when no monotonic clock is available,	2668	automatic timer adjustments even when no monotonic clock is available,
2525	can take avdantage of advanced kernel interfaces such as C<epoll> and	2669	can take avdantage of advanced kernel interfaces such as C<epoll> and
2526	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2670	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2527	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2671	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2528		2672
		2673	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2674	then this module will do nothing for you.
		2675
2529	=item L<Guard>	2676	=item L<Guard>
2530		2677
2531	The guard module, when used, will be used to implement	2678	The guard module, when used, will be used to implement
2532	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2679	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2533	lot less memory), but otherwise doesn't affect guard operation much. It is	2680	lot less memory), but otherwise doesn't affect guard operation much. It is
2534	purely used for performance.	2681	purely used for performance.
2535		2682
2536	=item L<JSON> and L<JSON::XS>	2683	=item L<JSON> and L<JSON::XS>
2537		2684
2538	One of these modules is required when you want to read or write JSON data	2685	One of these modules is required when you want to read or write JSON data
2539	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2686	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2540	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2687	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2541
2542	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2543	installed.
2544		2688
2545	=item L<Net::SSLeay>	2689	=item L<Net::SSLeay>
2546		2690
2547	Implementing TLS/SSL in Perl is certainly interesting, but not very	2691	Implementing TLS/SSL in Perl is certainly interesting, but not very
2548	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2692	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2549	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2693	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2550		2694
2551	=item L<Time::HiRes>	2695	=item L<Time::HiRes>
2552		2696
2553	This module is part of perl since release 5.008. It will be used when the	2697	This module is part of perl since release 5.008. It will be used when the
2554	chosen event library does not come with a timing source on it's own. The	2698	chosen event library does not come with a timing source of its own. The
2555	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2699	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2556	try to use a monotonic clock for timing stability.	2700	try to use a monotonic clock for timing stability.
2557		2701
2558	=back	2702	=back
2559		2703
2560		2704
…		…
2622	pronounced).	2766	pronounced).
2623		2767
2624		2768
2625	=head1 SEE ALSO	2769	=head1 SEE ALSO
2626		2770
		2771	Tutorial/Introduction: L<AnyEvent::Intro>.
		2772
		2773	FAQ: L<AnyEvent::FAQ>.
		2774
2627	Utility functions: L<AnyEvent::Util>.	2775	Utility functions: L<AnyEvent::Util>.
2628		2776
2629	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2777	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2630	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2778	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2631		2779
2632	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2780	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2633	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2781	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2634	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2782	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2635	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2783	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
…		…
2637	Non-blocking file handles, sockets, TCP clients and	2785	Non-blocking file handles, sockets, TCP clients and
2638	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2786	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2639		2787
2640	Asynchronous DNS: L<AnyEvent::DNS>.	2788	Asynchronous DNS: L<AnyEvent::DNS>.
2641		2789
2642	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2790	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2643	L<Coro::Event>,
2644		2791
2645	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2792	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2646	L<AnyEvent::HTTP>.	2793	L<AnyEvent::HTTP>.
2647		2794
2648		2795
2649	=head1 AUTHOR	2796	=head1 AUTHOR
2650		2797

Diff Legend

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