[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC vs.
Revision 1.379 by root, Fri Aug 26 18:09:04 2011 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC vs. Revision 1.379 by root, Fri Aug 26 18:09:04 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC vs.
Revision 1.379 by root, Fri Aug 26 18:09:04 2011 UTC