ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.328 by root, Tue Jun 8 10:06:15 2010 UTC vs.
Revision 1.373 by root, Thu Aug 25 03:08:48 2011 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - the DBI of event loop programming	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6	and POE are various supported event loops/environments.	6	FLTK and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
…		…
15	# file handle or descriptor readable	15	# file handle or descriptor readable
16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
17		17
18	# one-shot or repeating timers	18	# one-shot or repeating timers
19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
21		21
22	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
24		24
25	# POSIX signal	25	# POSIX signal
…		…
46	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
47	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
48		48
49	=head1 SUPPORT	49	=head1 SUPPORT
50		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
51	There is a mailinglist for discussing all things AnyEvent, and an IRC	53	There also is a mailinglist for discussing all things AnyEvent, and an IRC
52	channel, too.	54	channel, too.
53		55
54	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	56	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
55	Repository>, at L<http://anyevent.schmorp.de>, for more info.	57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
56		58
…		…
76	module users into the same thing by forcing them to use the same event	78	module users into the same thing by forcing them to use the same event
77	model you use.	79	model you use.
78		80
79	For modules like POE or IO::Async (which is a total misnomer as it is	81	For modules like POE or IO::Async (which is a total misnomer as it is
80	actually doing all I/O I<synchronously>...), using them in your module is	82	actually doing all I/O I<synchronously>...), using them in your module is
81	like joining a cult: After you joined, you are dependent on them and you	83	like joining a cult: After you join, you are dependent on them and you
82	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
83	that isn't them. What's worse, all the potential users of your	85	that isn't them. What's worse, all the potential users of your
84	module are I<also> forced to use the same event loop you use.	86	module are I<also> forced to use the same event loop you use.
85		87
86	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
87	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
88	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
89	your module uses one of those, every user of your module has to use it,	91	uses one of those, every user of your module has to use it, too. But if
90	too. But if your module uses AnyEvent, it works transparently with all	92	your module uses AnyEvent, it works transparently with all event models it
91	event models it supports (including stuff like IO::Async, as long as those	93	supports (including stuff like IO::Async, as long as those use one of the
92	use one of the supported event loops. It is trivial to add new event loops	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
93	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
94		96
95	In addition to being free of having to use I<the one and only true event	97	In addition to being free of having to use I<the one and only true event
96	model>, AnyEvent also is free of bloat and policy: with POE or similar	98	model>, AnyEvent also is free of bloat and policy: with POE or similar
97	modules, you get an enormous amount of code and strict rules you have to	99	modules, you get an enormous amount of code and strict rules you have to
98	follow. AnyEvent, on the other hand, is lean and up to the point, by only	100	follow. AnyEvent, on the other hand, is lean and to the point, by only
99	offering the functionality that is necessary, in as thin as a wrapper as	101	offering the functionality that is necessary, in as thin as a wrapper as
100	technically possible.	102	technically possible.
101		103
102	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
103	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
109	useful) and you want to force your users to use the one and only event	111	useful) and you want to force your users to use the one and only event
110	model, you should I<not> use this module.	112	model, you should I<not> use this module.
111		113
112	=head1 DESCRIPTION	114	=head1 DESCRIPTION
113		115
114	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
115	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
116	users to use the same event loop (as only a single event loop can coexist	118	module users to use a specific event loop implementation (since more
117	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
118		120
119	The interface itself is vaguely similar, but not identical to the L<Event>	121	The interface itself is vaguely similar, but not identical to the L<Event>
120	module.	122	module.
121		123
122	During the first call of any watcher-creation method, the module tries	124	During the first call of any watcher-creation method, the module tries
123	to detect the currently loaded event loop by probing whether one of the	125	to detect the currently loaded event loop by probing whether one of the
124	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
126	L<POE>. The first one found is used. If none are found, the module tries	128	found is used. If none are detected, the module tries to load the first
127	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	129	four modules in the order given; but note that if L<EV> is not
128	adaptor should always succeed) in the order given. The first one that can	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
129	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
130	found, AnyEvent will fall back to a pure-perl event loop, which is not
131	very efficient, but should work everywhere.
132		132
133	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
134	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
135	that model the default. For example:	135	that model the default. For example:
136		136
…		…
138	use AnyEvent;	138	use AnyEvent;
139		139
140	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
141		141
142	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
143	starts using it, all bets are off. Maybe you should tell their authors to	143	starts using it, all bets are off - this case should be very rare though,
144	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
145		146
146	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
147	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	other event modules you can load it explicitly and enjoy the high
148	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
149		150
150	=head1 WATCHERS	151	=head1 WATCHERS
151		152
152	AnyEvent has the central concept of a I<watcher>, which is an object that	153	AnyEvent has the central concept of a I<watcher>, which is an object that
153	stores relevant data for each kind of event you are waiting for, such as	154	stores relevant data for each kind of event you are waiting for, such as
…		…
158	callback when the event occurs (of course, only when the event model	159	callback when the event occurs (of course, only when the event model
159	is in control).	160	is in control).
160		161
161	Note that B<callbacks must not permanently change global variables>	162	Note that B<callbacks must not permanently change global variables>
162	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<	163	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
163	callbacks must not C<die> >>. The former is good programming practise in	164	callbacks must not C<die> >>. The former is good programming practice in
164	Perl and the latter stems from the fact that exception handling differs	165	Perl and the latter stems from the fact that exception handling differs
165	widely between event loops.	166	widely between event loops.
166		167
167	To disable the watcher you have to destroy it (e.g. by setting the	168	To disable a watcher you have to destroy it (e.g. by setting the
168	variable you store it in to C<undef> or otherwise deleting all references	169	variable you store it in to C<undef> or otherwise deleting all references
169	to it).	170	to it).
170		171
171	All watchers are created by calling a method on the C<AnyEvent> class.	172	All watchers are created by calling a method on the C<AnyEvent> class.
172		173
173	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
174	example), or need to refer to their watcher object in other ways.	175	example), or need to refer to their watcher object in other ways.
175		176
176	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
177		178
178	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
179	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
180	undef $w;	181	undef $w;
181	});	182	});
…		…
213		214
214	The I/O watcher might use the underlying file descriptor or a copy of it.	215	The I/O watcher might use the underlying file descriptor or a copy of it.
215	You must not close a file handle as long as any watcher is active on the	216	You must not close a file handle as long as any watcher is active on the
216	underlying file descriptor.	217	underlying file descriptor.
217		218
218	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
219	always use non-blocking calls when reading/writing from/to your file	220	always use non-blocking calls when reading/writing from/to your file
220	handles.	221	handles.
221		222
222	Example: wait for readability of STDIN, then read a line and disable the	223	Example: wait for readability of STDIN, then read a line and disable the
223	watcher.	224	watcher.
…		…
247		248
248	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
249	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
250	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
251		252
252	The callback will normally be invoked once only. If you specify another	253	The callback will normally be invoked only once. If you specify another
253	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
254	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
255	seconds) after the first invocation. If C<interval> is specified with a	256	seconds) after the first invocation. If C<interval> is specified with a
256	false value, then it is treated as if it were missing.	257	false value, then it is treated as if it were not specified at all.
257		258
258	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
259	attempt is done to avoid timer drift in most backends, so the interval is	260	attempt is made to avoid timer drift in most backends, so the interval is
260	only approximate.	261	only approximate.
261		262
262	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
263		264
264	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
282		283
283	While most event loops expect timers to specified in a relative way, they	284	While most event loops expect timers to specified in a relative way, they
284	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
285	"jumps", for example, when ntp decides to set your clock backwards from	286	"jumps", for example, when ntp decides to set your clock backwards from
286	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to	287	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
287	fire "after" a second might actually take six years to finally fire.	288	fire "after a second" might actually take six years to finally fire.
288		289
289	AnyEvent cannot compensate for this. The only event loop that is conscious	290	AnyEvent cannot compensate for this. The only event loop that is conscious
290	about these issues is L<EV>, which offers both relative (ev_timer, based	291	of these issues is L<EV>, which offers both relative (ev_timer, based
291	on true relative time) and absolute (ev_periodic, based on wallclock time)	292	on true relative time) and absolute (ev_periodic, based on wallclock time)
292	timers.	293	timers.
293		294
294	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
295	AnyEvent API.	296	AnyEvent API.
…		…
317	I<In almost all cases (in all cases if you don't care), this is the	318	I<In almost all cases (in all cases if you don't care), this is the
318	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
319		320
320	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
321	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
322	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
323		324
324	The rest of this section is only of relevance if you try to be very exact	325	The rest of this section is only of relevance if you try to be very exact
325	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
326		327
327	For a practical example of when these times differ, consider L<Event::Lib>	328	For a practical example of when these times differ, consider L<Event::Lib>
328	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
329		330
330	The event loop is running and has just invoked one of your callback at	331	The event loop is running and has just invoked one of your callbacks at
331	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
332	you wait a second by executing C<sleep 1> (blocking the process for a	333	you wait a second by executing C<sleep 1> (blocking the process for a
333	second) and then (at time=501) you create a relative timer that fires	334	second) and then (at time=501) you create a relative timer that fires
334	after three seconds.	335	after three seconds.
335		336
…		…
355	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
356	account.	357	account.
357		358
358	=item AnyEvent->now_update	359	=item AnyEvent->now_update
359		360
360	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache	361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
361	the current time for each loop iteration (see the discussion of L<<	362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
362	AnyEvent->now >>, above).	363	above).
363		364
364	When a callback runs for a long time (or when the process sleeps), then	365	When a callback runs for a long time (or when the process sleeps), then
365	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
366	might affect timers and time-outs.	367	might affect timers and time-outs.
367		368
…		…
428	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
429		430
430	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	431	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
431	callbacks to signals in a generic way, which is a pity, as you cannot	432	callbacks to signals in a generic way, which is a pity, as you cannot
432	do race-free signal handling in perl, requiring C libraries for	433	do race-free signal handling in perl, requiring C libraries for
433	this. AnyEvent will try to do it's best, which means in some cases,	434	this. AnyEvent will try to do its best, which means in some cases,
434	signals will be delayed. The maximum time a signal might be delayed is	435	signals will be delayed. The maximum time a signal might be delayed is
435	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
436	variable can be changed only before the first signal watcher is created,	437	variable can be changed only before the first signal watcher is created,
437	and should be left alone otherwise. This variable determines how often	438	and should be left alone otherwise. This variable determines how often
438	AnyEvent polls for signals (in case a wake-up was missed). Higher values	439	AnyEvent polls for signals (in case a wake-up was missed). Higher values
…		…
440	saving.	441	saving.
441		442
442	All these problems can be avoided by installing the optional	443	All these problems can be avoided by installing the optional
443	L<Async::Interrupt> module, which works with most event loops. It will not	444	L<Async::Interrupt> module, which works with most event loops. It will not
444	work with inherently broken event loops such as L<Event> or L<Event::Lib>	445	work with inherently broken event loops such as L<Event> or L<Event::Lib>
445	(and not with L<POE> currently, as POE does it's own workaround with	446	(and not with L<POE> currently, as POE does its own workaround with
446	one-second latency). For those, you just have to suffer the delays.	447	one-second latency). For those, you just have to suffer the delays.
447		448
448	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
449		450
450	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
451		452
452	You can also watch on a child process exit and catch its exit status.	453	You can also watch for a child process exit and catch its exit status.
453		454
454	The child process is specified by the C<pid> argument (one some backends,	455	The child process is specified by the C<pid> argument (on some backends,
455	using C<0> watches for any child process exit, on others this will	456	using C<0> watches for any child process exit, on others this will
456	croak). The watcher will be triggered only when the child process has	457	croak). The watcher will be triggered only when the child process has
457	finished and an exit status is available, not on any trace events	458	finished and an exit status is available, not on any trace events
458	(stopped/continued).	459	(stopped/continued).
459		460
…		…
481	thing in an AnyEvent program, you I<have> to create at least one	482	thing in an AnyEvent program, you I<have> to create at least one
482	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
483	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
484		485
485	As most event loops do not support waiting for child events, they will be	486	As most event loops do not support waiting for child events, they will be
486	emulated by AnyEvent in most cases, in which the latency and race problems	487	emulated by AnyEvent in most cases, in which case the latency and race
487	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
488		489
489	Example: fork a process and wait for it	490	Example: fork a process and wait for it
490		491
491	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
492		493
…		…
506		507
507	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
508		509
509	$w = AnyEvent->idle (cb => <callback>);	510	$w = AnyEvent->idle (cb => <callback>);
510		511
511	Repeatedly invoke the callback after the process becomes idle, until	512	This will repeatedly invoke the callback after the process becomes idle,
512	either the watcher is destroyed or new events have been detected.	513	until either the watcher is destroyed or new events have been detected.
513		514
514	Idle watchers are useful when there is a need to do something, but it	515	Idle watchers are useful when there is a need to do something, but it
515	is not so important (or wise) to do it instantly. The callback will be	516	is not so important (or wise) to do it instantly. The callback will be
516	invoked only when there is "nothing better to do", which is usually	517	invoked only when there is "nothing better to do", which is usually
517	defined as "all outstanding events have been handled and no new events	518	defined as "all outstanding events have been handled and no new events
…		…
587	the signal fires.	588	the signal fires.
588		589
589	=item * Condition variables are like "Merge Points" - points in your program	590	=item * Condition variables are like "Merge Points" - points in your program
590	where you merge multiple independent results/control flows into one.	591	where you merge multiple independent results/control flows into one.
591		592
592	=item * Condition variables represent a transaction - function that start	593	=item * Condition variables represent a transaction - functions that start
593	some kind of transaction can return them, leaving the caller the choice	594	some kind of transaction can return them, leaving the caller the choice
594	between waiting in a blocking fashion, or setting a callback.	595	between waiting in a blocking fashion, or setting a callback.
595		596
596	=item * Condition variables represent future values, or promises to deliver	597	=item * Condition variables represent future values, or promises to deliver
597	some result, long before the result is available.	598	some result, long before the result is available.
…		…
617		618
618	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
619	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
620	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
621	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
622	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
623		624
624	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
625	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
626	for the send to occur.	627	for the send to occur.
627		628
…		…
692	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
693	C<send>.	694	C<send>.
694		695
695	=item $cv->croak ($error)	696	=item $cv->croak ($error)
696		697
697	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
698	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
699		700
700	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
701	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
702	delays the error detetcion, but has the overwhelmign advantage that it	703	delays the error detection, but has the overwhelming advantage that it
703	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
704	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
705	the problem.	706	the problem.
706		707
707	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
708		709
709	=item $cv->end	710	=item $cv->end
…		…
747	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
748	sending.	749	sending.
749		750
750	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
751	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
752	begung can potentially be zero:	753	begun can potentially be zero:
753		754
754	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
755		756
756	my %result;	757	my %result;
757	$cv->begin (sub { shift->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
…		…
778	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
779	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
780	doesn't execute once).	781	doesn't execute once).
781		782
782	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
783	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
784	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
785	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,
786	call C<end>.	787	call C<end>.
787		788
788	=back	789	=back
…		…
795	=over 4	796	=over 4
796		797
797	=item $cv->recv	798	=item $cv->recv
798		799
799	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
800	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
801	normally.	802	normally.
802		803
803	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
804	will return immediately.	805	will return immediately.
805		806
…		…
822	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
823	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
824	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,
825	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
826		827
827	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
828	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
829	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
830	waits otherwise.	831	waits otherwise.
831		832
832	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
837	=item $cb = $cv->cb ($cb->($cv))	838	=item $cb = $cv->cb ($cb->($cv))
838		839
839	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
840	replaces it before doing so.	841	replaces it before doing so.
841		842
842	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
843	"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
844	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
845	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.
846		848
847	=back	849	=back
848		850
849	=head1 SUPPORTED EVENT LOOPS/BACKENDS	851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
850		852
…		…
858	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
859	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
860	AnyEvent itself.	862	AnyEvent itself.
861		863
862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
863	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
864		866
865	=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.
866		868
867	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
868	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
869	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
870	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
871	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.
872		874
…		…
874	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
875	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
876	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
877	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
878	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).
879		884
880	=item Backends with special needs.	885	=item Backends with special needs.
881		886
882	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
883	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
884	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
885	everything should just work.	890	everything should just work.
886		891
887	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
888		893
889	Support for IO::Async can only be partial, as it is too broken and
890	architecturally limited to even support the AnyEvent API. It also
891	is the only event loop that needs the loop to be set explicitly, so
892	it can only be used by a main program knowing about AnyEvent. See
893	L<AnyEvent::Impl::Async> for the gory details.
894
895	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
896
897	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
898		895
899	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
900		897
901	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>.
…		…
926	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
927	backend has been autodetected.	924	backend has been autodetected.
928		925
929	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
930	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
931	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
932	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
933	will be C<urxvt::anyevent>).	930	will be C<urxvt::anyevent>).
934		931
935	=item AnyEvent::detect	932	=item AnyEvent::detect
936		933
937	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
938	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
939	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
940	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).
941		942
942	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
943	created, use C<post_detect>.	944	created, use C<post_detect>.
944		945
945	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
946		947
947	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
948	autodetected (or immediately if this has already happened).	949	autodetected (or immediately if that has already happened).
949		950
950	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
951	(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
952	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
953	other initialisations - see the sources of L<AnyEvent::Strict> or	954	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
962	that automatically removes the callback again when it is destroyed (or	963	that automatically removes the callback again when it is destroyed (or
963	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
964	a case where this is useful.	965	a case where this is useful.
965		966
966	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
967	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.
968		969
969	our WATCHER;	970	our WATCHER;
970		971
971	my $guard = AnyEvent::post_detect {	972	my $guard = AnyEvent::post_detect {
972	$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);
…		…
980	$WATCHER ||= $guard;	981	$WATCHER ||= $guard;
981		982
982	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
983		984
984	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
985	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will be called directly
986	the event loop has been chosen.	987	after the event loop has been chosen.
987		988
988	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:
989	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
990	array will be ignored.	991	array will be ignored.
991		992
…		…
1008	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009	# as soon as it is	1010	# as soon as it is
1010	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011	}	1012	}
1012		1013
		1014	=item AnyEvent::postpone { BLOCK }
		1015
		1016	Arranges for the block to be executed as soon as possible, but not before
		1017	the call itself returns. In practise, the block will be executed just
		1018	before the event loop polls for new events, or shortly afterwards.
		1019
		1020	This function never returns anything (to make the C<return postpone { ...
		1021	}> idiom more useful.
		1022
		1023	To understand the usefulness of this function, consider a function that
		1024	asynchronously does something for you and returns some transaction
		1025	object or guard to let you cancel the operation. For example,
		1026	C<AnyEvent::Socket::tcp_connect>:
		1027
		1028	# start a conenction attempt unless one is active
		1029	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1030	delete $self->{connect_guard};
		1031	...
		1032	};
		1033
		1034	Imagine that this function could instantly call the callback, for
		1035	example, because it detects an obvious error such as a negative port
		1036	number. Invoking the callback before the function returns causes problems
		1037	however: the callback will be called and will try to delete the guard
		1038	object. But since the function hasn't returned yet, there is nothing to
		1039	delete. When the function eventually returns it will assign the guard
		1040	object to C<< $self->{connect_guard} >>, where it will likely never be
		1041	deleted, so the program thinks it is still trying to connect.
		1042
		1043	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1044	callback directly on error:
		1045
		1046	$cb->(undef), return # signal error to callback, BAD!
		1047	if $some_error_condition;
		1048
		1049	It should use C<postpone>:
		1050
		1051	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1052	if $some_error_condition;
		1053
		1054	=item AnyEvent::log $level, $msg[, @args]
		1055
		1056	Log the given C<$msg> at the given C<$level>.
		1057
		1058	Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
		1059	consequently, look at the L<AnyEvent::Log> documentation for details.
		1060
		1061	If you want to sprinkle loads of logging calls around your code, consider
		1062	creating a logger callback with the C<AnyEvent::Log::logger> function.
		1063
1013	=back	1064	=back
1014		1065
1015	=head1 WHAT TO DO IN A MODULE	1066	=head1 WHAT TO DO IN A MODULE
1016		1067
1017	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1068	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1027	because it will stall the whole program, and the whole point of using	1078	because it will stall the whole program, and the whole point of using
1028	events is to stay interactive.	1079	events is to stay interactive.
1029		1080
1030	It is fine, however, to call C<< ->recv >> when the user of your module	1081	It is fine, however, to call C<< ->recv >> when the user of your module
1031	requests it (i.e. if you create a http request object ad have a method	1082	requests it (i.e. if you create a http request object ad have a method
1032	called C<results> that returns the results, it should call C<< ->recv >>	1083	called C<results> that returns the results, it may call C<< ->recv >>
1033	freely, as the user of your module knows what she is doing. always).	1084	freely, as the user of your module knows what she is doing. Always).
1034		1085
1035	=head1 WHAT TO DO IN THE MAIN PROGRAM	1086	=head1 WHAT TO DO IN THE MAIN PROGRAM
1036		1087
1037	There will always be a single main program - the only place that should	1088	There will always be a single main program - the only place that should
1038	dictate which event model to use.	1089	dictate which event model to use.
1039		1090
1040	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1091	If the program is not event-based, it need not do anything special, even
1041	do anything special (it does not need to be event-based) and let AnyEvent	1092	when it depends on a module that uses an AnyEvent. If the program itself
1042	decide which implementation to chose if some module relies on it.	1093	uses AnyEvent, but does not care which event loop is used, all it needs
		1094	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1095	available loop implementation.
1043		1096
1044	If the main program relies on a specific event model - for example, in	1097	If the main program relies on a specific event model - for example, in
1045	Gtk2 programs you have to rely on the Glib module - you should load the	1098	Gtk2 programs you have to rely on the Glib module - you should load the
1046	event module before loading AnyEvent or any module that uses it: generally	1099	event module before loading AnyEvent or any module that uses it: generally
1047	speaking, you should load it as early as possible. The reason is that	1100	speaking, you should load it as early as possible. The reason is that
1048	modules might create watchers when they are loaded, and AnyEvent will	1101	modules might create watchers when they are loaded, and AnyEvent will
1049	decide on the event model to use as soon as it creates watchers, and it	1102	decide on the event model to use as soon as it creates watchers, and it
1050	might chose the wrong one unless you load the correct one yourself.	1103	might choose the wrong one unless you load the correct one yourself.
1051		1104
1052	You can chose to use a pure-perl implementation by loading the	1105	You can chose to use a pure-perl implementation by loading the
1053	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1106	C<AnyEvent::Loop> module, which gives you similar behaviour
1054	everywhere, but letting AnyEvent chose the model is generally better.	1107	everywhere, but letting AnyEvent chose the model is generally better.
1055		1108
1056	=head2 MAINLOOP EMULATION	1109	=head2 MAINLOOP EMULATION
1057		1110
1058	Sometimes (often for short test scripts, or even standalone programs who	1111	Sometimes (often for short test scripts, or even standalone programs who
…		…
1071		1124
1072		1125
1073	=head1 OTHER MODULES	1126	=head1 OTHER MODULES
1074		1127
1075	The following is a non-exhaustive list of additional modules that use	1128	The following is a non-exhaustive list of additional modules that use
1076	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1129	AnyEvent as a client and can therefore be mixed easily with other
1077	modules and other event loops in the same program. Some of the modules	1130	AnyEvent modules and other event loops in the same program. Some of the
1078	come as part of AnyEvent, the others are available via CPAN.	1131	modules come as part of AnyEvent, the others are available via CPAN (see
		1132	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1133	a longer non-exhaustive list), and the list is heavily biased towards
		1134	modules of the AnyEvent author himself :)
1079		1135
1080	=over 4	1136	=over 4
1081		1137
1082	=item L<AnyEvent::Util>	1138	=item L<AnyEvent::Util>
1083		1139
1084	Contains various utility functions that replace often-used but blocking	1140	Contains various utility functions that replace often-used blocking
1085	functions such as C<inet_aton> by event-/callback-based versions.	1141	functions such as C<inet_aton> with event/callback-based versions.
1086		1142
1087	=item L<AnyEvent::Socket>	1143	=item L<AnyEvent::Socket>
1088		1144
1089	Provides various utility functions for (internet protocol) sockets,	1145	Provides various utility functions for (internet protocol) sockets,
1090	addresses and name resolution. Also functions to create non-blocking tcp	1146	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1092		1148
1093	=item L<AnyEvent::Handle>	1149	=item L<AnyEvent::Handle>
1094		1150
1095	Provide read and write buffers, manages watchers for reads and writes,	1151	Provide read and write buffers, manages watchers for reads and writes,
1096	supports raw and formatted I/O, I/O queued and fully transparent and	1152	supports raw and formatted I/O, I/O queued and fully transparent and
1097	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1153	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1098		1154
1099	=item L<AnyEvent::DNS>	1155	=item L<AnyEvent::DNS>
1100		1156
1101	Provides rich asynchronous DNS resolver capabilities.	1157	Provides rich asynchronous DNS resolver capabilities.
1102		1158
…		…
1110		1166
1111	Here be danger!	1167	Here be danger!
1112		1168
1113	As Pauli would put it, "Not only is it not right, it's not even wrong!" -	1169	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1114	there are so many things wrong with AnyEvent::Handle::UDP, most notably	1170	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1115	it's use of a stream-based API with a protocol that isn't streamable, that	1171	its use of a stream-based API with a protocol that isn't streamable, that
1116	the only way to improve it is to delete it.	1172	the only way to improve it is to delete it.
1117		1173
1118	It features data corruption (but typically only under load) and general	1174	It features data corruption (but typically only under load) and general
1119	confusion. On top, the author is not only clueless about UDP but also	1175	confusion. On top, the author is not only clueless about UDP but also
1120	fact-resistant - some gems of his understanding: "connect doesn't work	1176	fact-resistant - some gems of his understanding: "connect doesn't work
…		…
1124	wrong with his module when it is explained to him.	1180	wrong with his module when it is explained to him.
1125		1181
1126	=item L<AnyEvent::DBI>	1182	=item L<AnyEvent::DBI>
1127		1183
1128	Executes L<DBI> requests asynchronously in a proxy process for you,	1184	Executes L<DBI> requests asynchronously in a proxy process for you,
1129	notifying you in an event-bnased way when the operation is finished.	1185	notifying you in an event-based way when the operation is finished.
1130		1186
1131	=item L<AnyEvent::AIO>	1187	=item L<AnyEvent::AIO>
1132		1188
1133	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1189	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1134	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1190	toolbox of every event programmer. AnyEvent::AIO transparently fuses
…		…
1153		1209
1154	package AnyEvent;	1210	package AnyEvent;
1155		1211
1156	# basically a tuned-down version of common::sense	1212	# basically a tuned-down version of common::sense
1157	sub common_sense {	1213	sub common_sense {
1158	# from common:.sense 1.0	1214	# from common:.sense 3.4
1159	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1215	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1160	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)	1216	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1161	$^H |= 0x00000600;	1217	$^H |= 0x00000600;
1162	}	1218	}
1163		1219
1164	BEGIN { AnyEvent::common_sense }	1220	BEGIN { AnyEvent::common_sense }
1165		1221
1166	use Carp ();	1222	use Carp ();
1167		1223
1168	our $VERSION = '5.271';	1224	our $VERSION = '6.01';
1169	our $MODEL;	1225	our $MODEL;
1170		1226
1171	our $AUTOLOAD;
1172	our @ISA;	1227	our @ISA;
1173		1228
1174	our @REGISTRY;	1229	our @REGISTRY;
1175		1230
1176	our $VERBOSE;	1231	our $VERBOSE;
…		…
1181	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1236	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1182		1237
1183	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1238	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1184	if ${^TAINT};	1239	if ${^TAINT};
1185		1240
		1241	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1242	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
		1243
		1244	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1245	if ${^TAINT};
		1246
1186	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1247	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1187
1188	}	1248	}
1189		1249
1190	our $MAX_SIGNAL_LATENCY = 10;	1250	our $MAX_SIGNAL_LATENCY = 10;
1191		1251
1192	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1252	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
…		…
1196	$PROTOCOL{$_} = ++$idx	1256	$PROTOCOL{$_} = ++$idx
1197	for reverse split /\s*,\s*/,	1257	for reverse split /\s*,\s*/,
1198	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1258	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1199	}	1259	}
1200		1260
		1261	our @post_detect;
		1262
		1263	sub post_detect(&) {
		1264	my ($cb) = @_;
		1265
		1266	push @post_detect, $cb;
		1267
		1268	defined wantarray
		1269	? bless \$cb, "AnyEvent::Util::postdetect"
		1270	: ()
		1271	}
		1272
		1273	sub AnyEvent::Util::postdetect::DESTROY {
		1274	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1275	}
		1276
		1277	our $POSTPONE_W;
		1278	our @POSTPONE;
		1279
		1280	sub _postpone_exec {
		1281	undef $POSTPONE_W;
		1282
		1283	&{ shift @POSTPONE }
		1284	while @POSTPONE;
		1285	}
		1286
		1287	sub postpone(&) {
		1288	push @POSTPONE, shift;
		1289
		1290	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1291
		1292	()
		1293	}
		1294
		1295	sub log($$;@) {
		1296	# only load the bug bloated module when we actually are about to log something
		1297	if ($_[0] <= $VERBOSE) {
		1298	require AnyEvent::Log;
		1299	# AnyEvent::Log overwrites this function
		1300	goto &log;
		1301	}
		1302	}
		1303
		1304	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1305	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1306	}
		1307
1201	my @models = (	1308	our @models = (
1202	[EV:: => AnyEvent::Impl::EV:: , 1],	1309	[EV:: => AnyEvent::Impl::EV:: , 1],
1203	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1310	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1204	# everything below here will not (normally) be autoprobed	1311	# everything below here will not (normally) be autoprobed
1205	# as the pureperl backend should work everywhere	1312	# as the pure perl backend should work everywhere
1206	# and is usually faster	1313	# and is usually faster
1207	[Event:: => AnyEvent::Impl::Event::, 1],	1314	[Event:: => AnyEvent::Impl::Event::, 1],
1208	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1315	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1209	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1316	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1210	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1317	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1211	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1318	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1212	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1319	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1213	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1320	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1214	[Wx:: => AnyEvent::Impl::POE::],	1321	[Wx:: => AnyEvent::Impl::POE::],
1215	[Prima:: => AnyEvent::Impl::POE::],	1322	[Prima:: => AnyEvent::Impl::POE::],
1216	# IO::Async is just too broken - we would need workarounds for its	1323	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1217	# byzantine signal and broken child handling, among others.	1324	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1218	# IO::Async is rather hard to detect, as it doesn't have any	1325	[FLTK:: => AnyEvent::Impl::FLTK2::],
1219	# obvious default class.
1220	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1221	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1222	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1223	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1224	);	1326	);
1225		1327
1226	our %method = map +($_ => 1),	1328	our @isa_hook;
		1329
		1330	sub _isa_set {
		1331	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1332
		1333	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1334	for 1 .. $#pkg;
		1335
		1336	grep $_ && $_->[1], @isa_hook
		1337	and AE::_reset ();
		1338	}
		1339
		1340	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1341	sub _isa_hook($$;$) {
		1342	my ($i, $pkg, $reset_ae) = @_;
		1343
		1344	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1345
		1346	_isa_set;
		1347	}
		1348
		1349	# all autoloaded methods reserve the complete glob, not just the method slot.
		1350	# due to bugs in perls method cache implementation.
1227	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1351	our @methods = qw(io timer time now now_update signal child idle condvar);
1228
1229	our @post_detect;
1230
1231	sub post_detect(&) {
1232	my ($cb) = @_;
1233
1234	push @post_detect, $cb;
1235
1236	defined wantarray
1237	? bless \$cb, "AnyEvent::Util::postdetect"
1238	: ()
1239	}
1240
1241	sub AnyEvent::Util::postdetect::DESTROY {
1242	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1243	}
1244		1352
1245	sub detect() {	1353	sub detect() {
		1354	return $MODEL if $MODEL; # some programs keep references to detect
		1355
		1356	local $!; # for good measure
		1357	local $SIG{__DIE__}; # we use eval
		1358
1246	# free some memory	1359	# free some memory
1247	*detect = sub () { $MODEL };	1360	*detect = sub () { $MODEL };
		1361	# undef &func doesn't correctly update the method cache. grmbl.
		1362	# so we delete the whole glob. grmbl.
		1363	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1364	# a glob with an active sub. hrm. i hope it works, but perl is
		1365	# usually buggy in this department. sigh.
		1366	delete @{"AnyEvent::"}{@methods};
		1367	undef @methods;
1248		1368
1249	local $!; # for good measure
1250	local $SIG{__DIE__};
1251
1252	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1369	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1253	my $model = "AnyEvent::Impl::$1";	1370	my $model = $1;
		1371	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1254	if (eval "require $model") {	1372	if (eval "require $model") {
		1373	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1255	$MODEL = $model;	1374	$MODEL = $model;
1256	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1257	} else {	1375	} else {
1258	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1376	AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1259	}	1377	}
1260	}	1378	}
1261		1379
1262	# check for already loaded models	1380	# check for already loaded models
1263	unless ($MODEL) {	1381	unless ($MODEL) {
1264	for (@REGISTRY, @models) {	1382	for (@REGISTRY, @models) {
1265	my ($package, $model) = @$_;	1383	my ($package, $model) = @$_;
1266	if (${"$package\::VERSION"} > 0) {	1384	if (${"$package\::VERSION"} > 0) {
1267	if (eval "require $model") {	1385	if (eval "require $model") {
		1386	AnyEvent::log 7 => "autodetected model '$model', using it.";
1268	$MODEL = $model;	1387	$MODEL = $model;
1269	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1270	last;	1388	last;
1271	}	1389	}
1272	}	1390	}
1273	}	1391	}
1274		1392
…		…
1280	$autoload	1398	$autoload
1281	and eval "require $package"	1399	and eval "require $package"
1282	and ${"$package\::VERSION"} > 0	1400	and ${"$package\::VERSION"} > 0
1283	and eval "require $model"	1401	and eval "require $model"
1284	) {	1402	) {
		1403	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1285	$MODEL = $model;	1404	$MODEL = $model;
1286	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1287	last;	1405	last;
1288	}	1406	}
1289	}	1407	}
1290		1408
1291	$MODEL	1409	$MODEL
1292	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1410	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1293	}	1411	}
1294	}	1412	}
1295		1413
1296	@models = (); # free probe data	1414	# free memory only needed for probing
		1415	undef @models;
		1416	undef @REGISTRY;
1297		1417
1298	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1418	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1299	unshift @ISA, $MODEL;
1300		1419
1301	# now nuke some methods that are overriden by the backend.	1420	# now nuke some methods that are overridden by the backend.
1302	# SUPER is not allowed.	1421	# SUPER usage is not allowed in these.
1303	for (qw(time signal child idle)) {	1422	for (qw(time signal child idle)) {
1304	undef &{"AnyEvent::Base::$_"}	1423	undef &{"AnyEvent::Base::$_"}
1305	if defined &{"$MODEL\::$_"};	1424	if defined &{"$MODEL\::$_"};
1306	}	1425	}
1307		1426
1308	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1427	_isa_set;
		1428
		1429	# we're officially open!
		1430
		1431	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1432	require AnyEvent::Strict;
		1433	}
		1434
		1435	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1436	require AnyEvent::Debug;
		1437	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1438	}
		1439
		1440	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1441	require AnyEvent::Socket;
		1442	require AnyEvent::Debug;
		1443
		1444	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1445	$shell =~ s/\$\$/$$/g;
		1446
		1447	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1448	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1449	}
		1450
		1451	# now the anyevent environment is set up as the user told us to, so
		1452	# call the actual user code - post detects
1309		1453
1310	(shift @post_detect)->() while @post_detect;	1454	(shift @post_detect)->() while @post_detect;
		1455	undef @post_detect;
1311		1456
1312	*post_detect = sub(&) {	1457	*post_detect = sub(&) {
1313	shift->();	1458	shift->();
1314		1459
1315	undef	1460	undef
1316	};	1461	};
1317		1462
1318	$MODEL	1463	$MODEL
1319	}	1464	}
1320		1465
1321	sub AUTOLOAD {	1466	for my $name (@methods) {
1322	(my $func = $AUTOLOAD) =~ s/.*://;	1467	*$name = sub {
1323
1324	$method{$func}
1325	or Carp::croak "$func: not a valid AnyEvent class method";
1326
1327	detect;	1468	detect;
1328		1469	# we use goto because
1329	my $class = shift;	1470	# a) it makes the thunk more transparent
1330	$class->$func (@_);	1471	# b) it allows us to delete the thunk later
		1472	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1473	};
1331	}	1474	}
1332		1475
1333	# utility function to dup a filehandle. this is used by many backends	1476	# utility function to dup a filehandle. this is used by many backends
1334	# to support binding more than one watcher per filehandle (they usually	1477	# to support binding more than one watcher per filehandle (they usually
1335	# allow only one watcher per fd, so we dup it to get a different one).	1478	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1359		1502
1360	package AE;	1503	package AE;
1361		1504
1362	our $VERSION = $AnyEvent::VERSION;	1505	our $VERSION = $AnyEvent::VERSION;
1363		1506
		1507	sub _reset() {
		1508	eval q{
1364	# fall back to the main API by default - backends and AnyEvent::Base	1509	# fall back to the main API by default - backends and AnyEvent::Base
1365	# implementations can overwrite these.	1510	# implementations can overwrite these.
1366		1511
1367	sub io($$$) {	1512	sub io($$$) {
1368	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1513	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1369	}	1514	}
1370		1515
1371	sub timer($$$) {	1516	sub timer($$$) {
1372	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1517	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1373	}	1518	}
1374		1519
1375	sub signal($$) {	1520	sub signal($$) {
1376	AnyEvent->signal (signal => $_[0], cb => $_[1])	1521	AnyEvent->signal (signal => $_[0], cb => $_[1])
1377	}	1522	}
1378		1523
1379	sub child($$) {	1524	sub child($$) {
1380	AnyEvent->child (pid => $_[0], cb => $_[1])	1525	AnyEvent->child (pid => $_[0], cb => $_[1])
1381	}	1526	}
1382		1527
1383	sub idle($) {	1528	sub idle($) {
1384	AnyEvent->idle (cb => $_[0])	1529	AnyEvent->idle (cb => $_[0]);
1385	}	1530	}
1386		1531
1387	sub cv(;&) {	1532	sub cv(;&) {
1388	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1533	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1389	}	1534	}
1390		1535
1391	sub now() {	1536	sub now() {
1392	AnyEvent->now	1537	AnyEvent->now
1393	}	1538	}
1394		1539
1395	sub now_update() {	1540	sub now_update() {
1396	AnyEvent->now_update	1541	AnyEvent->now_update
1397	}	1542	}
1398		1543
1399	sub time() {	1544	sub time() {
1400	AnyEvent->time	1545	AnyEvent->time
		1546	}
		1547
		1548	*postpone = \&AnyEvent::postpone;
		1549	*log = \&AnyEvent::log;
		1550	};
		1551	die if $@;
1401	}	1552	}
		1553
		1554	BEGIN { _reset }
1402		1555
1403	package AnyEvent::Base;	1556	package AnyEvent::Base;
1404		1557
1405	# default implementations for many methods	1558	# default implementations for many methods
1406		1559
1407	sub time {	1560	sub time {
1408	eval q{ # poor man's autoloading {}	1561	eval q{ # poor man's autoloading {}
1409	# probe for availability of Time::HiRes	1562	# probe for availability of Time::HiRes
1410	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1563	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1411	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1564	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
		1565	if $AnyEvent::VERBOSE >= 8;
		1566	*time = sub { Time::HiRes::time () };
1412	*AE::time = \&Time::HiRes::time;	1567	*AE::time = \& Time::HiRes::time ;
1413	# if (eval "use POSIX (); (POSIX::times())...	1568	# if (eval "use POSIX (); (POSIX::times())...
1414	} else {	1569	} else {
1415	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1570	AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
		1571	*time = sub { CORE::time };
1416	*AE::time = sub (){ time }; # epic fail	1572	*AE::time = sub (){ CORE::time };
1417	}	1573	}
1418		1574
1419	*time = sub { AE::time }; # different prototypes	1575	*now = \&time;
1420	};	1576	};
1421	die if $@;	1577	die if $@;
1422		1578
1423	&time	1579	&time
1424	}	1580	}
1425		1581
1426	*now = \&time;	1582	*now = \&time;
1427
1428	sub now_update { }	1583	sub now_update { }
1429		1584
		1585	sub _poll {
		1586	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1587	}
		1588
1430	# default implementation for ->condvar	1589	# default implementation for ->condvar
		1590	# in fact, the default should not be overwritten
1431		1591
1432	sub condvar {	1592	sub condvar {
1433	eval q{ # poor man's autoloading {}	1593	eval q{ # poor man's autoloading {}
1434	*condvar = sub {	1594	*condvar = sub {
1435	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1595	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1513		1673
1514	sub signal {	1674	sub signal {
1515	eval q{ # poor man's autoloading {}	1675	eval q{ # poor man's autoloading {}
1516	# probe for availability of Async::Interrupt	1676	# probe for availability of Async::Interrupt
1517	if (_have_async_interrupt) {	1677	if (_have_async_interrupt) {
1518	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1678	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
		1679	if $AnyEvent::VERBOSE >= 8;
1519		1680
1520	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1681	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1521	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1682	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1522		1683
1523	} else {	1684	} else {
1524	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1685	AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
		1686	if $AnyEvent::VERBOSE >= 8;
1525		1687
1526	if (AnyEvent::WIN32) {	1688	if (AnyEvent::WIN32) {
1527	require AnyEvent::Util;	1689	require AnyEvent::Util;
1528		1690
1529	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1691	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1605	: sysread $SIGPIPE_R, (my $dummy), 9;	1767	: sysread $SIGPIPE_R, (my $dummy), 9;
1606		1768
1607	while (%SIG_EV) {	1769	while (%SIG_EV) {
1608	for (keys %SIG_EV) {	1770	for (keys %SIG_EV) {
1609	delete $SIG_EV{$_};	1771	delete $SIG_EV{$_};
1610	$_->() for values %{ $SIG_CB{$_} || {} };	1772	&$_ for values %{ $SIG_CB{$_} || {} };
1611	}	1773	}
1612	}	1774	}
1613	};	1775	};
1614	};	1776	};
1615	die if $@;	1777	die if $@;
…		…
1620	# default implementation for ->child	1782	# default implementation for ->child
1621		1783
1622	our %PID_CB;	1784	our %PID_CB;
1623	our $CHLD_W;	1785	our $CHLD_W;
1624	our $CHLD_DELAY_W;	1786	our $CHLD_DELAY_W;
1625	our $WNOHANG;
1626		1787
1627	# used by many Impl's	1788	# used by many Impl's
1628	sub _emit_childstatus($$) {	1789	sub _emit_childstatus($$) {
1629	my (undef, $rpid, $rstatus) = @_;	1790	my (undef, $rpid, $rstatus) = @_;
1630		1791
…		…
1637	eval q{ # poor man's autoloading {}	1798	eval q{ # poor man's autoloading {}
1638	*_sigchld = sub {	1799	*_sigchld = sub {
1639	my $pid;	1800	my $pid;
1640		1801
1641	AnyEvent->_emit_childstatus ($pid, $?)	1802	AnyEvent->_emit_childstatus ($pid, $?)
1642	while ($pid = waitpid -1, $WNOHANG) > 0;	1803	while ($pid = waitpid -1, WNOHANG) > 0;
1643	};	1804	};
1644		1805
1645	*child = sub {	1806	*child = sub {
1646	my (undef, %arg) = @_;	1807	my (undef, %arg) = @_;
1647		1808
1648	defined (my $pid = $arg{pid} + 0)	1809	my $pid = $arg{pid};
1649	or Carp::croak "required option 'pid' is missing";	1810	my $cb = $arg{cb};
1650		1811
1651	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1812	$PID_CB{$pid}{$cb+0} = $cb;
1652
1653	# WNOHANG is almost cetrainly 1 everywhere
1654	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1655	? 1
1656	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1657		1813
1658	unless ($CHLD_W) {	1814	unless ($CHLD_W) {
1659	$CHLD_W = AE::signal CHLD => \&_sigchld;	1815	$CHLD_W = AE::signal CHLD => \&_sigchld;
1660	# child could be a zombie already, so make at least one round	1816	# child could be a zombie already, so make at least one round
1661	&_sigchld;	1817	&_sigchld;
1662	}	1818	}
1663		1819
1664	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1820	bless [$pid, $cb+0], "AnyEvent::Base::child"
1665	};	1821	};
1666		1822
1667	*AnyEvent::Base::child::DESTROY = sub {	1823	*AnyEvent::Base::child::DESTROY = sub {
1668	my ($pid, $cb) = @{$_[0]};	1824	my ($pid, $icb) = @{$_[0]};
1669		1825
1670	delete $PID_CB{$pid}{$cb};	1826	delete $PID_CB{$pid}{$icb};
1671	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1827	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1672		1828
1673	undef $CHLD_W unless keys %PID_CB;	1829	undef $CHLD_W unless keys %PID_CB;
1674	};	1830	};
1675	};	1831	};
…		…
1688		1844
1689	my ($cb, $w, $rcb) = $arg{cb};	1845	my ($cb, $w, $rcb) = $arg{cb};
1690		1846
1691	$rcb = sub {	1847	$rcb = sub {
1692	if ($cb) {	1848	if ($cb) {
1693	$w = _time;	1849	$w = AE::time;
1694	&$cb;	1850	&$cb;
1695	$w = _time - $w;	1851	$w = AE::time - $w;
1696		1852
1697	# never use more then 50% of the time for the idle watcher,	1853	# never use more then 50% of the time for the idle watcher,
1698	# within some limits	1854	# within some limits
1699	$w = 0.0001 if $w < 0.0001;	1855	$w = 0.0001 if $w < 0.0001;
1700	$w = 5 if $w > 5;	1856	$w = 5 if $w > 5;
…		…
1723		1879
1724	package AnyEvent::CondVar;	1880	package AnyEvent::CondVar;
1725		1881
1726	our @ISA = AnyEvent::CondVar::Base::;	1882	our @ISA = AnyEvent::CondVar::Base::;
1727		1883
		1884	# only to be used for subclassing
		1885	sub new {
		1886	my $class = shift;
		1887	bless AnyEvent->condvar (@_), $class
		1888	}
		1889
1728	package AnyEvent::CondVar::Base;	1890	package AnyEvent::CondVar::Base;
1729		1891
1730	#use overload	1892	#use overload
1731	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1893	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1732	# fallback => 1;	1894	# fallback => 1;
…		…
1741		1903
1742	sub _send {	1904	sub _send {
1743	# nop	1905	# nop
1744	}	1906	}
1745		1907
		1908	sub _wait {
		1909	AnyEvent->_poll until $_[0]{_ae_sent};
		1910	}
		1911
1746	sub send {	1912	sub send {
1747	my $cv = shift;	1913	my $cv = shift;
1748	$cv->{_ae_sent} = [@_];	1914	$cv->{_ae_sent} = [@_];
1749	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1915	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1750	$cv->_send;	1916	$cv->_send;
…		…
1757		1923
1758	sub ready {	1924	sub ready {
1759	$_[0]{_ae_sent}	1925	$_[0]{_ae_sent}
1760	}	1926	}
1761		1927
1762	sub _wait {
1763	$WAITING
1764	and !$_[0]{_ae_sent}
1765	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1766
1767	local $WAITING = 1;
1768	AnyEvent->one_event while !$_[0]{_ae_sent};
1769	}
1770
1771	sub recv {	1928	sub recv {
		1929	unless ($_[0]{_ae_sent}) {
		1930	$WAITING
		1931	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1932
		1933	local $WAITING = 1;
1772	$_[0]->_wait;	1934	$_[0]->_wait;
		1935	}
1773		1936
1774	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1937	$_[0]{_ae_croak}
1775	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1938	and Carp::croak $_[0]{_ae_croak};
		1939
		1940	wantarray
		1941	? @{ $_[0]{_ae_sent} }
		1942	: $_[0]{_ae_sent}[0]
1776	}	1943	}
1777		1944
1778	sub cb {	1945	sub cb {
1779	my $cv = shift;	1946	my $cv = shift;
1780		1947
…		…
1796	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1963	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1797	}	1964	}
1798		1965
1799	# undocumented/compatibility with pre-3.4	1966	# undocumented/compatibility with pre-3.4
1800	*broadcast = \&send;	1967	*broadcast = \&send;
1801	*wait = \&_wait;	1968	*wait = \&recv;
1802		1969
1803	=head1 ERROR AND EXCEPTION HANDLING	1970	=head1 ERROR AND EXCEPTION HANDLING
1804		1971
1805	In general, AnyEvent does not do any error handling - it relies on the	1972	In general, AnyEvent does not do any error handling - it relies on the
1806	caller to do that if required. The L<AnyEvent::Strict> module (see also	1973	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1818	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	1985	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1819	so on.	1986	so on.
1820		1987
1821	=head1 ENVIRONMENT VARIABLES	1988	=head1 ENVIRONMENT VARIABLES
1822		1989
1823	The following environment variables are used by this module or its	1990	AnyEvent supports a number of environment variables that tune the
1824	submodules.	1991	runtime behaviour. They are usually evaluated when AnyEvent is
		1992	loaded, initialised, or a submodule that uses them is loaded. Many of
		1993	them also cause AnyEvent to load additional modules - for example,
		1994	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		1995	loaded.
1825		1996
1826	Note that AnyEvent will remove I<all> environment variables starting with	1997	All the environment variables documented here start with
1827	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	1998	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1828	enabled.	1999	namespace. Other modules are encouraged (but by no means required) to use
		2000	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2001	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2002	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2003	variables starting with C<AE_>, see below).
		2004
		2005	All variables can also be set via the C<AE_> prefix, that is, instead
		2006	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2007	case there is a clash btween anyevent and another program that uses
		2008	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2009	variable to the empty string, as those variables take precedence.
		2010
		2011	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2012	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2013	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2014	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2015	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2016	is set).
		2017
		2018	The exact algorithm is currently:
		2019
		2020	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2021	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2022	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2023
		2024	This ensures that child processes will not see the C<AE_> variables.
		2025
		2026	The following environment variables are currently known to AnyEvent:
1829		2027
1830	=over 4	2028	=over 4
1831		2029
1832	=item C<PERL_ANYEVENT_VERBOSE>	2030	=item C<PERL_ANYEVENT_VERBOSE>
1833		2031
1834	By default, AnyEvent will be completely silent except in fatal	2032	By default, AnyEvent will be completely silent except in fatal
1835	conditions. You can set this environment variable to make AnyEvent more	2033	conditions. You can set this environment variable to make AnyEvent more
1836	talkative.	2034	talkative. If you want to do more than just set the global logging level
		2035	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2036	complex specifications.
1837		2037
1838	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2038	When set to C<5> or higher, causes AnyEvent to warn about unexpected
1839	conditions, such as not being able to load the event model specified by	2039	conditions, such as not being able to load the event model specified by
1840	C<PERL_ANYEVENT_MODEL>.	2040	C<PERL_ANYEVENT_MODEL>.
1841		2041
1842	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2042	When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1843	model it chooses.	2043	model it chooses.
1844		2044
1845	When set to C<8> or higher, then AnyEvent will report extra information on	2045	When set to C<8> or higher, then AnyEvent will report extra information on
1846	which optional modules it loads and how it implements certain features.	2046	which optional modules it loads and how it implements certain features.
		2047
		2048	=item C<PERL_ANYEVENT_LOG>
		2049
		2050	Accepts rather complex logging specifications. For example, you could log
		2051	all C<debug> messages of some module to stderr, warnings and above to
		2052	stderr, and errors and above to syslog, with:
		2053
		2054	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2055
		2056	For the rather extensive details, see L<AnyEvent::Log>.
		2057
		2058	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2059	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2060	using the latter saves a few hundred kB of memory until the first message
		2061	is being logged.
1847		2062
1848	=item C<PERL_ANYEVENT_STRICT>	2063	=item C<PERL_ANYEVENT_STRICT>
1849		2064
1850	AnyEvent does not do much argument checking by default, as thorough	2065	AnyEvent does not do much argument checking by default, as thorough
1851	argument checking is very costly. Setting this variable to a true value	2066	argument checking is very costly. Setting this variable to a true value
…		…
1853	check the arguments passed to most method calls. If it finds any problems,	2068	check the arguments passed to most method calls. If it finds any problems,
1854	it will croak.	2069	it will croak.
1855		2070
1856	In other words, enables "strict" mode.	2071	In other words, enables "strict" mode.
1857		2072
1858	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	2073	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1859	>>, it is definitely recommended to keep it off in production. Keeping	2074	>>, it is definitely recommended to keep it off in production. Keeping
1860	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2075	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1861	can be very useful, however.	2076	can be very useful, however.
1862		2077
		2078	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2079
		2080	If this env variable is set, then its contents will be interpreted by
		2081	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2082	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2083	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2084
		2085	This takes place when the first watcher is created.
		2086
		2087	For example, to bind a debug shell on a unix domain socket in
		2088	F<< /tmp/debug<pid>.sock >>, you could use this:
		2089
		2090	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2091
		2092	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2093	systems.
		2094
		2095	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2096
		2097	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2098	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2099
1863	=item C<PERL_ANYEVENT_MODEL>	2100	=item C<PERL_ANYEVENT_MODEL>
1864		2101
1865	This can be used to specify the event model to be used by AnyEvent, before	2102	This can be used to specify the event model to be used by AnyEvent, before
1866	auto detection and -probing kicks in. It must be a string consisting	2103	auto detection and -probing kicks in.
1867	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2104
		2105	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2106	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1868	and the resulting module name is loaded and if the load was successful,	2107	resulting module name is loaded and - if the load was successful - used as
1869	used as event model. If it fails to load AnyEvent will proceed with	2108	event model backend. If it fails to load then AnyEvent will proceed with
1870	auto detection and -probing.	2109	auto detection and -probing.
1871		2110
1872	This functionality might change in future versions.	2111	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2112	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2113	the end of a string designates a module name and quotes it appropriately).
1873		2114
1874	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2115	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1875	could start your program like this:	2116	could start your program like this:
1876		2117
1877	PERL_ANYEVENT_MODEL=Perl perl ...	2118	PERL_ANYEVENT_MODEL=Perl perl ...
1878		2119
1879	=item C<PERL_ANYEVENT_PROTOCOLS>	2120	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1895	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2136	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1896	- only support IPv4, never try to resolve or contact IPv6	2137	- only support IPv4, never try to resolve or contact IPv6
1897	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2138	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1898	IPv6, but prefer IPv6 over IPv4.	2139	IPv6, but prefer IPv6 over IPv4.
1899		2140
		2141	=item C<PERL_ANYEVENT_HOSTS>
		2142
		2143	This variable, if specified, overrides the F</etc/hosts> file used by
		2144	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2145	from that file instead.
		2146
1900	=item C<PERL_ANYEVENT_EDNS0>	2147	=item C<PERL_ANYEVENT_EDNS0>
1901		2148
1902	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2149	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1903	for DNS. This extension is generally useful to reduce DNS traffic, but	2150	DNS. This extension is generally useful to reduce DNS traffic, especially
1904	some (broken) firewalls drop such DNS packets, which is why it is off by	2151	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1905	default.	2152	packets, which is why it is off by default.
1906		2153
1907	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2154	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1908	EDNS0 in its DNS requests.	2155	EDNS0 in its DNS requests.
1909		2156
1910	=item C<PERL_ANYEVENT_MAX_FORKS>	2157	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1918	resolver - this is the maximum number of parallel DNS requests that are	2165	resolver - this is the maximum number of parallel DNS requests that are
1919	sent to the DNS server.	2166	sent to the DNS server.
1920		2167
1921	=item C<PERL_ANYEVENT_RESOLV_CONF>	2168	=item C<PERL_ANYEVENT_RESOLV_CONF>
1922		2169
1923	The file to use instead of F</etc/resolv.conf> (or OS-specific	2170	The absolute path to a F<resolv.conf>-style file to use instead of
1924	configuration) in the default resolver. When set to the empty string, no	2171	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1925	default config will be used.	2172	resolver, or the empty string to select the default configuration.
1926		2173
1927	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2174	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1928		2175
1929	When neither C<ca_file> nor C<ca_path> was specified during	2176	When neither C<ca_file> nor C<ca_path> was specified during
1930	L<AnyEvent::TLS> context creation, and either of these environment	2177	L<AnyEvent::TLS> context creation, and either of these environment
1931	variables exist, they will be used to specify CA certificate locations	2178	variables are nonempty, they will be used to specify CA certificate
1932	instead of a system-dependent default.	2179	locations instead of a system-dependent default.
1933		2180
1934	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2181	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1935		2182
1936	When these are set to C<1>, then the respective modules are not	2183	When these are set to C<1>, then the respective modules are not
1937	loaded. Mostly good for testing AnyEvent itself.	2184	loaded. Mostly good for testing AnyEvent itself.
…		…
2269	(even when used without AnyEvent), but most event loops have acceptable	2516	(even when used without AnyEvent), but most event loops have acceptable
2270	performance with or without AnyEvent.	2517	performance with or without AnyEvent.
2271		2518
2272	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2519	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2273	the actual event loop, only with extremely fast event loops such as EV	2520	the actual event loop, only with extremely fast event loops such as EV
2274	adds AnyEvent significant overhead.	2521	does AnyEvent add significant overhead.
2275		2522
2276	=item * You should avoid POE like the plague if you want performance or	2523	=item * You should avoid POE like the plague if you want performance or
2277	reasonable memory usage.	2524	reasonable memory usage.
2278		2525
2279	=back	2526	=back
…		…
2509	unless defined $SIG{PIPE};	2756	unless defined $SIG{PIPE};
2510		2757
2511	=head1 RECOMMENDED/OPTIONAL MODULES	2758	=head1 RECOMMENDED/OPTIONAL MODULES
2512		2759
2513	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2760	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2514	it's built-in modules) are required to use it.	2761	its built-in modules) are required to use it.
2515		2762
2516	That does not mean that AnyEvent won't take advantage of some additional	2763	That does not mean that AnyEvent won't take advantage of some additional
2517	modules if they are installed.	2764	modules if they are installed.
2518		2765
2519	This section explains which additional modules will be used, and how they	2766	This section explains which additional modules will be used, and how they
…		…
2577	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2824	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2578		2825
2579	=item L<Time::HiRes>	2826	=item L<Time::HiRes>
2580		2827
2581	This module is part of perl since release 5.008. It will be used when the	2828	This module is part of perl since release 5.008. It will be used when the
2582	chosen event library does not come with a timing source on it's own. The	2829	chosen event library does not come with a timing source of its own. The
2583	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2830	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2584	try to use a monotonic clock for timing stability.	2831	try to use a monotonic clock for timing stability.
2585		2832
2586	=back	2833	=back
2587		2834
2588		2835
…		…
2650	pronounced).	2897	pronounced).
2651		2898
2652		2899
2653	=head1 SEE ALSO	2900	=head1 SEE ALSO
2654		2901
2655	Utility functions: L<AnyEvent::Util>.	2902	Tutorial/Introduction: L<AnyEvent::Intro>.
2656		2903
2657	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2904	FAQ: L<AnyEvent::FAQ>.
2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2905
		2906	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2907	(simply logging).
		2908
		2909	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2910	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2911
		2912	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2913	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2914	L<Qt>, L<POE>, L<FLTK>.
2659		2915
2660	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2916	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2917	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2918	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2919	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2920	L<AnyEvent::Impl::FLTK>.
2664		2921
2665	Non-blocking file handles, sockets, TCP clients and	2922	Non-blocking handles, pipes, stream sockets, TCP clients and
2666	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2923	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667		2924
2668	Asynchronous DNS: L<AnyEvent::DNS>.	2925	Asynchronous DNS: L<AnyEvent::DNS>.
2669		2926
2670	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2927	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2671	L<Coro::Event>,
2672		2928
2673	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2929	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2674	L<AnyEvent::HTTP>.	2930	L<AnyEvent::HTTP>.
2675		2931
2676		2932
2677	=head1 AUTHOR	2933	=head1 AUTHOR
2678		2934

Diff Legend

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