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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.301 by root, Tue Dec 1 18:04:21 2009 UTC vs.
Revision 1.340 by root, Fri Dec 3 18:39:06 2010 UTC

…		…
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18		21
19	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21		24
22	# POSIX signal	25	# POSIX signal
…		…
43	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
45		48
46	=head1 SUPPORT	49	=head1 SUPPORT
47		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	53	There also is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	54	channel, too.
50		55
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	56	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Repository>, at L<http://anyevent.schmorp.de>, for more info.	57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		58
…		…
73	module users into the same thing by forcing them to use the same event	78	module users into the same thing by forcing them to use the same event
74	model you use.	79	model you use.
75		80
76	For modules like POE or IO::Async (which is a total misnomer as it is	81	For modules like POE or IO::Async (which is a total misnomer as it is
77	actually doing all I/O I<synchronously>...), using them in your module is	82	actually doing all I/O I<synchronously>...), using them in your module is
78	like joining a cult: After you joined, you are dependent on them and you	83	like joining a cult: After you join, you are dependent on them and you
79	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
80	that isn't them. What's worse, all the potential users of your	85	that isn't them. What's worse, all the potential users of your
81	module are I<also> forced to use the same event loop you use.	86	module are I<also> forced to use the same event loop you use.
82		87
83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
85	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
86	your module uses one of those, every user of your module has to use it,	91	your module uses one of those, every user of your module has to use it,
87	too. But if your module uses AnyEvent, it works transparently with all	92	too. But if your module uses AnyEvent, it works transparently with all
88	event models it supports (including stuff like IO::Async, as long as those	93	event models it supports (including stuff like IO::Async, as long as those
89	use one of the supported event loops. It is trivial to add new event loops	94	use one of the supported event loops. It is easy to add new event loops
90	to AnyEvent, too, so it is future-proof).	95	to AnyEvent, too, 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::Impl::Perl>,
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::Impl::Perl> 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
144	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
145	explicitly and enjoy the high availability of that event loop :)	149	explicitly and enjoy the high availability of that event loop :)
146		150
…		…
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
…		…
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
…		…
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	Sometimes there is a need to do something, but it is not so important	512	This will repeatedly invoke the callback after the process becomes idle,
509	to do it instantly, but only when there is nothing better to do. This	513	until either the watcher is destroyed or new events have been detected.
510	"nothing better to do" is usually defined to be "no other events need
511	attention by the event loop".
512		514
513	Idle watchers ideally get invoked when the event loop has nothing	515	Idle watchers are useful when there is a need to do something, but it
514	better to do, just before it would block the process to wait for new	516	is not so important (or wise) to do it instantly. The callback will be
515	events. Instead of blocking, the idle watcher is invoked.	517	invoked only when there is "nothing better to do", which is usually
		518	defined as "all outstanding events have been handled and no new events
		519	have been detected". That means that idle watchers ideally get invoked
		520	when the event loop has just polled for new events but none have been
		521	detected. Instead of blocking to wait for more events, the idle watchers
		522	will be invoked.
516		523
517	Most event loops unfortunately do not really support idle watchers (only	524	Unfortunately, most event loops do not really support idle watchers (only
518	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	525	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
519	will simply call the callback "from time to time".	526	will simply call the callback "from time to time".
520		527
521	Example: read lines from STDIN, but only process them when the	528	Example: read lines from STDIN, but only process them when the
522	program is otherwise idle:	529	program is otherwise idle:
…		…
550	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
551		558
552	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
553	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).
554		561
555	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
556	because they represent a condition that must become true.	563	they represent a condition that must become true.
557		564
558	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.
559		566
560	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
561	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
…		…
566	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
567	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
568	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<<
569	->send >> method).	576	->send >> method).
570		577
571	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
572	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:
573	in time where multiple outstanding events have been processed. And yet	580
574	another way to call them is transactions - each condition variable can be	581	=over 4
575	used to represent a transaction, which finishes at some point and delivers	582
576	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
577	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
578		601
579	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
580	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,
581	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
582	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
…		…
595		618
596	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
597	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
598	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
599	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
600	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
601		624
602	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
603	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
604	for the send to occur.	627	for the send to occur.
605		628
606	Example: wait for a timer.	629	Example: wait for a timer.
607		630
608	# wait till the result is ready	631	# condition: "wait till the timer is fired"
609	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
610		633
611	# do something such as adding a timer	634	# create the timer - we could wait for, say
612	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
613	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
614	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
615	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
616	after => 1,	639	after => 1,
617	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
618	);	641	);
619		642
620	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
621	# calls ->send	644	# calls ->send
622	$result_ready->recv;	645	$timer_fired->recv;
623		646
624	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
625	variables are also callable directly.	648	variables are also callable directly.
626		649
627	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
…		…
670	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
671	C<send>.	694	C<send>.
672		695
673	=item $cv->croak ($error)	696	=item $cv->croak ($error)
674		697
675	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
676	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
677		700
678	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
679	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
680	delays the error detetcion, but has the overwhelmign advantage that it	703	delays the error detection, but has the overwhelming advantage that it
681	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
682	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
683	the problem.	706	the problem.
684		707
685	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
686		709
687	=item $cv->end	710	=item $cv->end
…		…
725	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
726	sending.	749	sending.
727		750
728	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
729	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
730	begung can potentially be zero:	753	begun can potentially be zero:
731		754
732	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
733		756
734	my %result;	757	my %result;
735	$cv->begin (sub { shift->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
…		…
756	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
757	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
758	doesn't execute once).	781	doesn't execute once).
759		782
760	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
761	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
762	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
763	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,
764	call C<end>.	787	call C<end>.
765		788
766	=back	789	=back
…		…
773	=over 4	796	=over 4
774		797
775	=item $cv->recv	798	=item $cv->recv
776		799
777	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
778	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
779	normally.	802	normally.
780		803
781	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
782	will return immediately.	805	will return immediately.
783		806
…		…
800	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
801	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
802	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,
803	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
804		827
805	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
806	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
807	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
808	waits otherwise.	831	waits otherwise.
809		832
810	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
815	=item $cb = $cv->cb ($cb->($cv))	838	=item $cb = $cv->cb ($cb->($cv))
816		839
817	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
818	replaces it before doing so.	841	replaces it before doing so.
819		842
820	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
821	"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
822	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
823	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.
824		848
825	=back	849	=back
826		850
827	=head1 SUPPORTED EVENT LOOPS/BACKENDS	851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
828		852
…		…
840	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
841	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
842		866
843	=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.
844		868
845	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
846	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
847	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
848	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
849	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.
850		874
…		…
866		890
867	Support for IO::Async can only be partial, as it is too broken and	891	Support for IO::Async can only be partial, as it is too broken and
868	architecturally limited to even support the AnyEvent API. It also	892	architecturally limited to even support the AnyEvent API. It also
869	is the only event loop that needs the loop to be set explicitly, so	893	is the only event loop that needs the loop to be set explicitly, so
870	it can only be used by a main program knowing about AnyEvent. See	894	it can only be used by a main program knowing about AnyEvent. See
871	L<AnyEvent::Impl::Async> for the gory details.	895	L<AnyEvent::Impl::IOAsync> for the gory details.
872		896
873	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.	897	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
874		898
875	=item Event loops that are indirectly supported via other backends.	899	=item Event loops that are indirectly supported via other backends.
876		900
…		…
904	Contains C<undef> until the first watcher is being created, before the	928	Contains C<undef> until the first watcher is being created, before the
905	backend has been autodetected.	929	backend has been autodetected.
906		930
907	Afterwards it contains the event model that is being used, which is the	931	Afterwards it contains the event model that is being used, which is the
908	name of the Perl class implementing the model. This class is usually one	932	name of the Perl class implementing the model. This class is usually one
909	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the	933	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
910	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it	934	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
911	will be C<urxvt::anyevent>).	935	will be C<urxvt::anyevent>).
912		936
913	=item AnyEvent::detect	937	=item AnyEvent::detect
914		938
915	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	939	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
916	if necessary. You should only call this function right before you would	940	if necessary. You should only call this function right before you would
917	have created an AnyEvent watcher anyway, that is, as late as possible at	941	have created an AnyEvent watcher anyway, that is, as late as possible at
918	runtime, and not e.g. while initialising of your module.	942	runtime, and not e.g. during initialisation of your module.
919		943
920	If you need to do some initialisation before AnyEvent watchers are	944	If you need to do some initialisation before AnyEvent watchers are
921	created, use C<post_detect>.	945	created, use C<post_detect>.
922		946
923	=item $guard = AnyEvent::post_detect { BLOCK }	947	=item $guard = AnyEvent::post_detect { BLOCK }
924		948
925	Arranges for the code block to be executed as soon as the event model is	949	Arranges for the code block to be executed as soon as the event model is
926	autodetected (or immediately if this has already happened).	950	autodetected (or immediately if that has already happened).
927		951
928	The block will be executed I<after> the actual backend has been detected	952	The block will be executed I<after> the actual backend has been detected
929	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been	953	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
930	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do	954	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
931	other initialisations - see the sources of L<AnyEvent::Strict> or	955	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
940	that automatically removes the callback again when it is destroyed (or	964	that automatically removes the callback again when it is destroyed (or
941	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for	965	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
942	a case where this is useful.	966	a case where this is useful.
943		967
944	Example: Create a watcher for the IO::AIO module and store it in	968	Example: Create a watcher for the IO::AIO module and store it in
945	C<$WATCHER>. Only do so after the event loop is initialised, though.	969	C<$WATCHER>, but do so only do so after the event loop is initialised.
946		970
947	our WATCHER;	971	our WATCHER;
948		972
949	my $guard = AnyEvent::post_detect {	973	my $guard = AnyEvent::post_detect {
950	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	974	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
958	$WATCHER \|\|= $guard;	982	$WATCHER \|\|= $guard;
959		983
960	=item @AnyEvent::post_detect	984	=item @AnyEvent::post_detect
961		985
962	If there are any code references in this array (you can C<push> to it	986	If there are any code references in this array (you can C<push> to it
963	before or after loading AnyEvent), then they will called directly after	987	before or after loading AnyEvent), then they will be called directly
964	the event loop has been chosen.	988	after the event loop has been chosen.
965		989
966	You should check C<$AnyEvent::MODEL> before adding to this array, though:	990	You should check C<$AnyEvent::MODEL> before adding to this array, though:
967	if it is defined then the event loop has already been detected, and the	991	if it is defined then the event loop has already been detected, and the
968	array will be ignored.	992	array will be ignored.
969		993
970	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	994	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
971	it,as it takes care of these details.	995	it, as it takes care of these details.
972		996
973	This variable is mainly useful for modules that can do something useful	997	This variable is mainly useful for modules that can do something useful
974	when AnyEvent is used and thus want to know when it is initialised, but do	998	when AnyEvent is used and thus want to know when it is initialised, but do
975	not need to even load it by default. This array provides the means to hook	999	not need to even load it by default. This array provides the means to hook
976	into AnyEvent passively, without loading it.	1000	into AnyEvent passively, without loading it.
977		1001
		1002	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1003	together, you could put this into Coro (this is the actual code used by
		1004	Coro to accomplish this):
		1005
		1006	if (defined $AnyEvent::MODEL) {
		1007	# AnyEvent already initialised, so load Coro::AnyEvent
		1008	require Coro::AnyEvent;
		1009	} else {
		1010	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1011	# as soon as it is
		1012	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1013	}
		1014
978	=back	1015	=back
979		1016
980	=head1 WHAT TO DO IN A MODULE	1017	=head1 WHAT TO DO IN A MODULE
981		1018
982	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1019	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
992	because it will stall the whole program, and the whole point of using	1029	because it will stall the whole program, and the whole point of using
993	events is to stay interactive.	1030	events is to stay interactive.
994		1031
995	It is fine, however, to call C<< ->recv >> when the user of your module	1032	It is fine, however, to call C<< ->recv >> when the user of your module
996	requests it (i.e. if you create a http request object ad have a method	1033	requests it (i.e. if you create a http request object ad have a method
997	called C<results> that returns the results, it should call C<< ->recv >>	1034	called C<results> that returns the results, it may call C<< ->recv >>
998	freely, as the user of your module knows what she is doing. always).	1035	freely, as the user of your module knows what she is doing. Always).
999		1036
1000	=head1 WHAT TO DO IN THE MAIN PROGRAM	1037	=head1 WHAT TO DO IN THE MAIN PROGRAM
1001		1038
1002	There will always be a single main program - the only place that should	1039	There will always be a single main program - the only place that should
1003	dictate which event model to use.	1040	dictate which event model to use.
1004		1041
1005	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1042	If the program is not event-based, it need not do anything special, even
1006	do anything special (it does not need to be event-based) and let AnyEvent	1043	when it depends on a module that uses an AnyEvent. If the program itself
1007	decide which implementation to chose if some module relies on it.	1044	uses AnyEvent, but does not care which event loop is used, all it needs
		1045	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1046	available loop implementation.
1008		1047
1009	If the main program relies on a specific event model - for example, in	1048	If the main program relies on a specific event model - for example, in
1010	Gtk2 programs you have to rely on the Glib module - you should load the	1049	Gtk2 programs you have to rely on the Glib module - you should load the
1011	event module before loading AnyEvent or any module that uses it: generally	1050	event module before loading AnyEvent or any module that uses it: generally
1012	speaking, you should load it as early as possible. The reason is that	1051	speaking, you should load it as early as possible. The reason is that
1013	modules might create watchers when they are loaded, and AnyEvent will	1052	modules might create watchers when they are loaded, and AnyEvent will
1014	decide on the event model to use as soon as it creates watchers, and it	1053	decide on the event model to use as soon as it creates watchers, and it
1015	might chose the wrong one unless you load the correct one yourself.	1054	might choose the wrong one unless you load the correct one yourself.
1016		1055
1017	You can chose to use a pure-perl implementation by loading the	1056	You can chose to use a pure-perl implementation by loading the
1018	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1057	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
1019	everywhere, but letting AnyEvent chose the model is generally better.	1058	everywhere, but letting AnyEvent chose the model is generally better.
1020		1059
…		…
1038	=head1 OTHER MODULES	1077	=head1 OTHER MODULES
1039		1078
1040	The following is a non-exhaustive list of additional modules that use	1079	The following is a non-exhaustive list of additional modules that use
1041	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1080	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1042	modules and other event loops in the same program. Some of the modules	1081	modules and other event loops in the same program. Some of the modules
1043	come with AnyEvent, most are available via CPAN.	1082	come as part of AnyEvent, the others are available via CPAN.
1044		1083
1045	=over 4	1084	=over 4
1046		1085
1047	=item L<AnyEvent::Util>	1086	=item L<AnyEvent::Util>
1048		1087
1049	Contains various utility functions that replace often-used but blocking	1088	Contains various utility functions that replace often-used blocking
1050	functions such as C<inet_aton> by event-/callback-based versions.	1089	functions such as C<inet_aton> with event/callback-based versions.
1051		1090
1052	=item L<AnyEvent::Socket>	1091	=item L<AnyEvent::Socket>
1053		1092
1054	Provides various utility functions for (internet protocol) sockets,	1093	Provides various utility functions for (internet protocol) sockets,
1055	addresses and name resolution. Also functions to create non-blocking tcp	1094	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1057		1096
1058	=item L<AnyEvent::Handle>	1097	=item L<AnyEvent::Handle>
1059		1098
1060	Provide read and write buffers, manages watchers for reads and writes,	1099	Provide read and write buffers, manages watchers for reads and writes,
1061	supports raw and formatted I/O, I/O queued and fully transparent and	1100	supports raw and formatted I/O, I/O queued and fully transparent and
1062	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1101	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1063		1102
1064	=item L<AnyEvent::DNS>	1103	=item L<AnyEvent::DNS>
1065		1104
1066	Provides rich asynchronous DNS resolver capabilities.	1105	Provides rich asynchronous DNS resolver capabilities.
1067		1106
		1107	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1108
		1109	Implement event-based interfaces to the protocols of the same name (for
		1110	the curious, IGS is the International Go Server and FCP is the Freenet
		1111	Client Protocol).
		1112
		1113	=item L<AnyEvent::Handle::UDP>
		1114
		1115	Here be danger!
		1116
		1117	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1118	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1119	its use of a stream-based API with a protocol that isn't streamable, that
		1120	the only way to improve it is to delete it.
		1121
		1122	It features data corruption (but typically only under load) and general
		1123	confusion. On top, the author is not only clueless about UDP but also
		1124	fact-resistant - some gems of his understanding: "connect doesn't work
		1125	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1126	packets", "I don't need to implement proper error checking as UDP doesn't
		1127	support error checking" and so on - he doesn't even understand what's
		1128	wrong with his module when it is explained to him.
		1129
1068	=item L<AnyEvent::HTTP>	1130	=item L<AnyEvent::DBI>
1069		1131
1070	A simple-to-use HTTP library that is capable of making a lot of concurrent	1132	Executes L<DBI> requests asynchronously in a proxy process for you,
1071	HTTP requests.	1133	notifying you in an event-based way when the operation is finished.
		1134
		1135	=item L<AnyEvent::AIO>
		1136
		1137	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1138	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1139	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1140	file I/O, and much more.
1072		1141
1073	=item L<AnyEvent::HTTPD>	1142	=item L<AnyEvent::HTTPD>
1074		1143
1075	Provides a simple web application server framework.	1144	A simple embedded webserver.
1076		1145
1077	=item L<AnyEvent::FastPing>	1146	=item L<AnyEvent::FastPing>
1078		1147
1079	The fastest ping in the west.	1148	The fastest ping in the west.
1080
1081	=item L<AnyEvent::DBI>
1082
1083	Executes L<DBI> requests asynchronously in a proxy process.
1084
1085	=item L<AnyEvent::AIO>
1086
1087	Truly asynchronous I/O, should be in the toolbox of every event
1088	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1089	together.
1090
1091	=item L<AnyEvent::BDB>
1092
1093	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1094	L<BDB> and AnyEvent together.
1095
1096	=item L<AnyEvent::GPSD>
1097
1098	A non-blocking interface to gpsd, a daemon delivering GPS information.
1099
1100	=item L<AnyEvent::IRC>
1101
1102	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1103
1104	=item L<AnyEvent::XMPP>
1105
1106	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1107	Net::XMPP2>.
1108
1109	=item L<AnyEvent::IGS>
1110
1111	A non-blocking interface to the Internet Go Server protocol (used by
1112	L<App::IGS>).
1113
1114	=item L<Net::FCP>
1115
1116	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1117	of AnyEvent.
1118
1119	=item L<Event::ExecFlow>
1120
1121	High level API for event-based execution flow control.
1122		1149
1123	=item L<Coro>	1150	=item L<Coro>
1124		1151
1125	Has special support for AnyEvent via L<Coro::AnyEvent>.	1152	Has special support for AnyEvent via L<Coro::AnyEvent>.
1126		1153
…		…
1130		1157
1131	package AnyEvent;	1158	package AnyEvent;
1132		1159
1133	# basically a tuned-down version of common::sense	1160	# basically a tuned-down version of common::sense
1134	sub common_sense {	1161	sub common_sense {
1135	# from common:.sense 1.0	1162	# from common:.sense 3.3
1136	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";	1163	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";
1137	# use strict vars subs	1164	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1138	$^H \|= 0x00000600;	1165	$^H \|= 0x00000600;
1139	}	1166	}
1140		1167
1141	BEGIN { AnyEvent::common_sense }	1168	BEGIN { AnyEvent::common_sense }
1142		1169
1143	use Carp ();	1170	use Carp ();
1144		1171
1145	our $VERSION = '5.21';	1172	our $VERSION = '5.29';
1146	our $MODEL;	1173	our $MODEL;
1147		1174
1148	our $AUTOLOAD;	1175	our $AUTOLOAD;
1149	our @ISA;	1176	our @ISA;
1150		1177
1151	our @REGISTRY;	1178	our @REGISTRY;
1152		1179
1153	our $VERBOSE;	1180	our $VERBOSE;
1154		1181
1155	BEGIN {	1182	BEGIN {
1156	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1183	require "AnyEvent/constants.pl";
		1184
1157	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1185	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1158		1186
1159	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1187	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1160	if ${^TAINT};	1188	if ${^TAINT};
1161		1189
1162	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1190	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1205	our @post_detect;	1233	our @post_detect;
1206		1234
1207	sub post_detect(&) {	1235	sub post_detect(&) {
1208	my ($cb) = @_;	1236	my ($cb) = @_;
1209		1237
1210	if ($MODEL) {
1211	$cb->();
1212
1213	undef
1214	} else {
1215	push @post_detect, $cb;	1238	push @post_detect, $cb;
1216		1239
1217	defined wantarray	1240	defined wantarray
1218	? bless \$cb, "AnyEvent::Util::postdetect"	1241	? bless \$cb, "AnyEvent::Util::postdetect"
1219	: ()	1242	: ()
1220	}
1221	}	1243	}
1222		1244
1223	sub AnyEvent::Util::postdetect::DESTROY {	1245	sub AnyEvent::Util::postdetect::DESTROY {
1224	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1246	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1225	}	1247	}
1226		1248
1227	sub detect() {	1249	sub detect() {
		1250	# free some memory
		1251	*detect = sub () { $MODEL };
		1252
		1253	local $!; # for good measure
		1254	local $SIG{__DIE__};
		1255
		1256	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1257	my $model = "AnyEvent::Impl::$1";
		1258	if (eval "require $model") {
		1259	$MODEL = $model;
		1260	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1261	} else {
		1262	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1263	}
		1264	}
		1265
		1266	# check for already loaded models
1228	unless ($MODEL) {	1267	unless ($MODEL) {
1229	local $SIG{__DIE__};	1268	for (@REGISTRY, @models) {
1230		1269	my ($package, $model) = @$_;
1231	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1270	if (${"$package\::VERSION"} > 0) {
1232	my $model = "AnyEvent::Impl::$1";
1233	if (eval "require $model") {	1271	if (eval "require $model") {
1234	$MODEL = $model;	1272	$MODEL = $model;
1235	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1273	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1236	} else {	1274	last;
1237	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1275	}
1238	}	1276	}
1239	}	1277	}
1240		1278
1241	# check for already loaded models
1242	unless ($MODEL) {	1279	unless ($MODEL) {
		1280	# try to autoload a model
1243	for (@REGISTRY, @models) {	1281	for (@REGISTRY, @models) {
1244	my ($package, $model) = @$_;	1282	my ($package, $model, $autoload) = @$_;
		1283	if (
		1284	$autoload
		1285	and eval "require $package"
1245	if (${"$package\::VERSION"} > 0) {	1286	and ${"$package\::VERSION"} > 0
1246	if (eval "require $model") {	1287	and eval "require $model"
		1288	) {
1247	$MODEL = $model;	1289	$MODEL = $model;
1248	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1290	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1249	last;	1291	last;
1250	}
1251	}	1292	}
1252	}	1293	}
1253		1294
1254	unless ($MODEL) {
1255	# try to autoload a model
1256	for (@REGISTRY, @models) {
1257	my ($package, $model, $autoload) = @$_;
1258	if (
1259	$autoload
1260	and eval "require $package"
1261	and ${"$package\::VERSION"} > 0
1262	and eval "require $model"
1263	) {
1264	$MODEL = $model;
1265	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1266	last;
1267	}
1268	}
1269
1270	$MODEL	1295	$MODEL
1271	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1296	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1272	}
1273	}	1297	}
1274
1275	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1276
1277	unshift @ISA, $MODEL;
1278
1279	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1280
1281	(shift @post_detect)->() while @post_detect;
1282	}	1298	}
		1299
		1300	@models = (); # free probe data
		1301
		1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1303	unshift @ISA, $MODEL;
		1304
		1305	# now nuke some methods that are overridden by the backend.
		1306	# SUPER is not allowed.
		1307	for (qw(time signal child idle)) {
		1308	undef &{"AnyEvent::Base::$_"}
		1309	if defined &{"$MODEL\::$_"};
		1310	}
		1311
		1312	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1313	eval { require AnyEvent::Strict };
		1314	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
		1315	if $@ && $VERBOSE;
		1316	}
		1317
		1318	(shift @post_detect)->() while @post_detect;
		1319
		1320	*post_detect = sub(&) {
		1321	shift->();
		1322
		1323	undef
		1324	};
1283		1325
1284	$MODEL	1326	$MODEL
1285	}	1327	}
1286		1328
1287	sub AUTOLOAD {	1329	sub AUTOLOAD {
1288	(my $func = $AUTOLOAD) =~ s/.*://;	1330	(my $func = $AUTOLOAD) =~ s/.*://;
1289		1331
1290	$method{$func}	1332	$method{$func}
1291	or Carp::croak "$func: not a valid method for AnyEvent objects";	1333	or Carp::croak "$func: not a valid AnyEvent class method";
1292		1334
1293	detect unless $MODEL;	1335	detect;
1294		1336
1295	my $class = shift;	1337	my $class = shift;
1296	$class->$func (@_);	1338	$class->$func (@_);
1297	}	1339	}
1298		1340
…		…
1315		1357
1316	=head1 SIMPLIFIED AE API	1358	=head1 SIMPLIFIED AE API
1317		1359
1318	Starting with version 5.0, AnyEvent officially supports a second, much	1360	Starting with version 5.0, AnyEvent officially supports a second, much
1319	simpler, API that is designed to reduce the calling, typing and memory	1361	simpler, API that is designed to reduce the calling, typing and memory
1320	overhead.	1362	overhead by using function call syntax and a fixed number of parameters.
1321		1363
1322	See the L<AE> manpage for details.	1364	See the L<AE> manpage for details.
1323		1365
1324	=cut	1366	=cut
1325		1367
1326	package AE;	1368	package AE;
1327		1369
1328	our $VERSION = $AnyEvent::VERSION;	1370	our $VERSION = $AnyEvent::VERSION;
		1371
		1372	# fall back to the main API by default - backends and AnyEvent::Base
		1373	# implementations can overwrite these.
1329		1374
1330	sub io($$$) {	1375	sub io($$$) {
1331	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1376	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1332	}	1377	}
1333		1378
…		…
1365		1410
1366	package AnyEvent::Base;	1411	package AnyEvent::Base;
1367		1412
1368	# default implementations for many methods	1413	# default implementations for many methods
1369		1414
1370	sub _time() {	1415	sub time {
		1416	eval q{ # poor man's autoloading {}
1371	# probe for availability of Time::HiRes	1417	# probe for availability of Time::HiRes
1372	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1418	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1373	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1419	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1374	*_time = \&Time::HiRes::time;	1420	*AE::time = \&Time::HiRes::time;
1375	# if (eval "use POSIX (); (POSIX::times())...	1421	# if (eval "use POSIX (); (POSIX::times())...
1376	} else {	1422	} else {
1377	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1423	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1378	*_time = sub { time }; # epic fail	1424	*AE::time = sub (){ time }; # epic fail
		1425	}
		1426
		1427	*time = sub { AE::time }; # different prototypes
1379	}	1428	};
		1429	die if $@;
1380		1430
1381	&_time	1431	&time
1382	}	1432	}
1383		1433
1384	sub time { _time }	1434	*now = \&time;
1385	sub now { _time }	1435
1386	sub now_update { }	1436	sub now_update { }
1387		1437
1388	# default implementation for ->condvar	1438	# default implementation for ->condvar
1389		1439
1390	sub condvar {	1440	sub condvar {
		1441	eval q{ # poor man's autoloading {}
		1442	*condvar = sub {
1391	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1443	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1444	};
		1445
		1446	*AE::cv = sub (;&) {
		1447	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1448	};
		1449	};
		1450	die if $@;
		1451
		1452	&condvar
1392	}	1453	}
1393		1454
1394	# default implementation for ->signal	1455	# default implementation for ->signal
1395		1456
1396	our $HAVE_ASYNC_INTERRUPT;	1457	our $HAVE_ASYNC_INTERRUPT;
…		…
1405		1466
1406	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1467	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1407	our (%SIG_ASY, %SIG_ASY_W);	1468	our (%SIG_ASY, %SIG_ASY_W);
1408	our ($SIG_COUNT, $SIG_TW);	1469	our ($SIG_COUNT, $SIG_TW);
1409		1470
1410	sub _signal_exec {
1411	$HAVE_ASYNC_INTERRUPT
1412	? $SIGPIPE_R->drain
1413	: sysread $SIGPIPE_R, (my $dummy), 9;
1414
1415	while (%SIG_EV) {
1416	for (keys %SIG_EV) {
1417	delete $SIG_EV{$_};
1418	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1419	}
1420	}
1421	}
1422
1423	# install a dummy wakeup watcher to reduce signal catching latency	1471	# install a dummy wakeup watcher to reduce signal catching latency
		1472	# used by Impls
1424	sub _sig_add() {	1473	sub _sig_add() {
1425	unless ($SIG_COUNT++) {	1474	unless ($SIG_COUNT++) {
1426	# try to align timer on a full-second boundary, if possible	1475	# try to align timer on a full-second boundary, if possible
1427	my $NOW = AE::now;	1476	my $NOW = AE::now;
1428		1477
…		…
1438	undef $SIG_TW	1487	undef $SIG_TW
1439	unless --$SIG_COUNT;	1488	unless --$SIG_COUNT;
1440	}	1489	}
1441		1490
1442	our $_sig_name_init; $_sig_name_init = sub {	1491	our $_sig_name_init; $_sig_name_init = sub {
1443	eval q{ # poor man's autoloading	1492	eval q{ # poor man's autoloading {}
1444	undef $_sig_name_init;	1493	undef $_sig_name_init;
1445		1494
1446	if (_have_async_interrupt) {	1495	if (_have_async_interrupt) {
1447	*sig2num = \&Async::Interrupt::sig2num;	1496	*sig2num = \&Async::Interrupt::sig2num;
1448	*sig2name = \&Async::Interrupt::sig2name;	1497	*sig2name = \&Async::Interrupt::sig2name;
…		…
1480	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1529	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1481		1530
1482	} else {	1531	} else {
1483	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1532	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1484		1533
1485	require Fcntl;
1486
1487	if (AnyEvent::WIN32) {	1534	if (AnyEvent::WIN32) {
1488	require AnyEvent::Util;	1535	require AnyEvent::Util;
1489		1536
1490	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1537	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1491	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1538	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1492	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1539	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1493	} else {	1540	} else {
1494	pipe $SIGPIPE_R, $SIGPIPE_W;	1541	pipe $SIGPIPE_R, $SIGPIPE_W;
1495	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1542	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1496	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1543	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1497		1544
1498	# not strictly required, as $^F is normally 2, but let's make sure...	1545	# not strictly required, as $^F is normally 2, but let's make sure...
1499	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1546	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1500	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1547	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1501	}	1548	}
1502		1549
1503	$SIGPIPE_R	1550	$SIGPIPE_R
1504	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1551	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1505		1552
1506	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1553	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1507	}	1554	}
1508		1555
1509	*signal = sub {	1556	*signal = $HAVE_ASYNC_INTERRUPT
		1557	? sub {
1510	my (undef, %arg) = @_;	1558	my (undef, %arg) = @_;
1511		1559
1512	my $signal = uc $arg{signal}
1513	or Carp::croak "required option 'signal' is missing";
1514
1515	if ($HAVE_ASYNC_INTERRUPT) {
1516	# async::interrupt	1560	# async::interrupt
1517
1518	$signal = sig2num $signal;	1561	my $signal = sig2num $arg{signal};
1519	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1562	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1520		1563
1521	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1564	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1522	cb => sub { undef $SIG_EV{$signal} },	1565	cb => sub { undef $SIG_EV{$signal} },
1523	signal => $signal,	1566	signal => $signal,
1524	pipe => [$SIGPIPE_R->filenos],	1567	pipe => [$SIGPIPE_R->filenos],
1525	pipe_autodrain => 0,	1568	pipe_autodrain => 0,
1526	;	1569	;
1527		1570
1528	} else {	1571	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1572	}
		1573	: sub {
		1574	my (undef, %arg) = @_;
		1575
1529	# pure perl	1576	# pure perl
1530
1531	# AE::Util has been loaded in signal
1532	$signal = sig2name $signal;	1577	my $signal = sig2name $arg{signal};
1533	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1578	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1534		1579
1535	$SIG{$signal} \|\|= sub {	1580	$SIG{$signal} \|\|= sub {
1536	local $!;	1581	local $!;
1537	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1582	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1538	undef $SIG_EV{$signal};	1583	undef $SIG_EV{$signal};
1539	};	1584	};
1540		1585
1541	# can't do signal processing without introducing races in pure perl,	1586	# can't do signal processing without introducing races in pure perl,
1542	# so limit the signal latency.	1587	# so limit the signal latency.
1543	_sig_add;	1588	_sig_add;
1544	}
1545		1589
1546	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1590	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1591	}
1547	};	1592	;
1548		1593
1549	*AnyEvent::Base::signal::DESTROY = sub {	1594	*AnyEvent::Base::signal::DESTROY = sub {
1550	my ($signal, $cb) = @{$_[0]};	1595	my ($signal, $cb) = @{$_[0]};
1551		1596
1552	_sig_del;	1597	_sig_del;
…		…
1559	# print weird messages, or just unconditionally exit	1604	# print weird messages, or just unconditionally exit
1560	# instead of getting the default action.	1605	# instead of getting the default action.
1561	undef $SIG{$signal}	1606	undef $SIG{$signal}
1562	unless keys %{ $SIG_CB{$signal} };	1607	unless keys %{ $SIG_CB{$signal} };
1563	};	1608	};
		1609
		1610	*_signal_exec = sub {
		1611	$HAVE_ASYNC_INTERRUPT
		1612	? $SIGPIPE_R->drain
		1613	: sysread $SIGPIPE_R, (my $dummy), 9;
		1614
		1615	while (%SIG_EV) {
		1616	for (keys %SIG_EV) {
		1617	delete $SIG_EV{$_};
		1618	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1619	}
		1620	}
		1621	};
1564	};	1622	};
1565	die if $@;	1623	die if $@;
		1624
1566	&signal	1625	&signal
1567	}	1626	}
1568		1627
1569	# default implementation for ->child	1628	# default implementation for ->child
1570		1629
1571	our %PID_CB;	1630	our %PID_CB;
1572	our $CHLD_W;	1631	our $CHLD_W;
1573	our $CHLD_DELAY_W;	1632	our $CHLD_DELAY_W;
1574	our $WNOHANG;	1633	our $WNOHANG;
1575		1634
		1635	# used by many Impl's
1576	sub _emit_childstatus($$) {	1636	sub _emit_childstatus($$) {
1577	my (undef, $rpid, $rstatus) = @_;	1637	my (undef, $rpid, $rstatus) = @_;
1578		1638
1579	$_->($rpid, $rstatus)	1639	$_->($rpid, $rstatus)
1580	for values %{ $PID_CB{$rpid} \|\| {} },	1640	for values %{ $PID_CB{$rpid} \|\| {} },
1581	values %{ $PID_CB{0} \|\| {} };	1641	values %{ $PID_CB{0} \|\| {} };
1582	}	1642	}
1583		1643
1584	sub _sigchld {
1585	my $pid;
1586
1587	AnyEvent->_emit_childstatus ($pid, $?)
1588	while ($pid = waitpid -1, $WNOHANG) > 0;
1589	}
1590
1591	sub child {	1644	sub child {
		1645	eval q{ # poor man's autoloading {}
		1646	*_sigchld = sub {
		1647	my $pid;
		1648
		1649	AnyEvent->_emit_childstatus ($pid, $?)
		1650	while ($pid = waitpid -1, $WNOHANG) > 0;
		1651	};
		1652
		1653	*child = sub {
1592	my (undef, %arg) = @_;	1654	my (undef, %arg) = @_;
1593		1655
1594	defined (my $pid = $arg{pid} + 0)	1656	defined (my $pid = $arg{pid} + 0)
1595	or Carp::croak "required option 'pid' is missing";	1657	or Carp::croak "required option 'pid' is missing";
1596		1658
1597	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1659	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1598		1660
1599	# WNOHANG is almost cetrainly 1 everywhere	1661	# WNOHANG is almost cetrainly 1 everywhere
1600	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1662	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1601	? 1	1663	? 1
1602	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1664	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1603		1665
1604	unless ($CHLD_W) {	1666	unless ($CHLD_W) {
1605	$CHLD_W = AE::signal CHLD => \&_sigchld;	1667	$CHLD_W = AE::signal CHLD => \&_sigchld;
1606	# child could be a zombie already, so make at least one round	1668	# child could be a zombie already, so make at least one round
1607	&_sigchld;	1669	&_sigchld;
1608	}	1670	}
1609		1671
1610	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1672	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1611	}	1673	};
1612		1674
1613	sub AnyEvent::Base::child::DESTROY {	1675	*AnyEvent::Base::child::DESTROY = sub {
1614	my ($pid, $cb) = @{$_[0]};	1676	my ($pid, $cb) = @{$_[0]};
1615		1677
1616	delete $PID_CB{$pid}{$cb};	1678	delete $PID_CB{$pid}{$cb};
1617	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1679	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1618		1680
1619	undef $CHLD_W unless keys %PID_CB;	1681	undef $CHLD_W unless keys %PID_CB;
		1682	};
		1683	};
		1684	die if $@;
		1685
		1686	&child
1620	}	1687	}
1621		1688
1622	# idle emulation is done by simply using a timer, regardless	1689	# idle emulation is done by simply using a timer, regardless
1623	# of whether the process is idle or not, and not letting	1690	# of whether the process is idle or not, and not letting
1624	# the callback use more than 50% of the time.	1691	# the callback use more than 50% of the time.
1625	sub idle {	1692	sub idle {
		1693	eval q{ # poor man's autoloading {}
		1694	*idle = sub {
1626	my (undef, %arg) = @_;	1695	my (undef, %arg) = @_;
1627		1696
1628	my ($cb, $w, $rcb) = $arg{cb};	1697	my ($cb, $w, $rcb) = $arg{cb};
1629		1698
1630	$rcb = sub {	1699	$rcb = sub {
1631	if ($cb) {	1700	if ($cb) {
1632	$w = _time;	1701	$w = _time;
1633	&$cb;	1702	&$cb;
1634	$w = _time - $w;	1703	$w = _time - $w;
1635		1704
1636	# never use more then 50% of the time for the idle watcher,	1705	# never use more then 50% of the time for the idle watcher,
1637	# within some limits	1706	# within some limits
1638	$w = 0.0001 if $w < 0.0001;	1707	$w = 0.0001 if $w < 0.0001;
1639	$w = 5 if $w > 5;	1708	$w = 5 if $w > 5;
1640		1709
1641	$w = AE::timer $w, 0, $rcb;	1710	$w = AE::timer $w, 0, $rcb;
1642	} else {	1711	} else {
1643	# clean up...	1712	# clean up...
1644	undef $w;	1713	undef $w;
1645	undef $rcb;	1714	undef $rcb;
		1715	}
		1716	};
		1717
		1718	$w = AE::timer 0.05, 0, $rcb;
		1719
		1720	bless \\$cb, "AnyEvent::Base::idle"
1646	}	1721	};
		1722
		1723	*AnyEvent::Base::idle::DESTROY = sub {
		1724	undef $${$_[0]};
		1725	};
1647	};	1726	};
		1727	die if $@;
1648		1728
1649	$w = AE::timer 0.05, 0, $rcb;	1729	&idle
1650
1651	bless \\$cb, "AnyEvent::Base::idle"
1652	}
1653
1654	sub AnyEvent::Base::idle::DESTROY {
1655	undef $${$_[0]};
1656	}	1730	}
1657		1731
1658	package AnyEvent::CondVar;	1732	package AnyEvent::CondVar;
1659		1733
1660	our @ISA = AnyEvent::CondVar::Base::;	1734	our @ISA = AnyEvent::CondVar::Base::;
		1735
		1736	# only to be used for subclassing
		1737	sub new {
		1738	my $class = shift;
		1739	bless AnyEvent->condvar (@_), $class
		1740	}
1661		1741
1662	package AnyEvent::CondVar::Base;	1742	package AnyEvent::CondVar::Base;
1663		1743
1664	#use overload	1744	#use overload
1665	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1745	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
…		…
1787	check the arguments passed to most method calls. If it finds any problems,	1867	check the arguments passed to most method calls. If it finds any problems,
1788	it will croak.	1868	it will croak.
1789		1869
1790	In other words, enables "strict" mode.	1870	In other words, enables "strict" mode.
1791		1871
1792	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	1872	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1793	>>, it is definitely recommended to keep it off in production. Keeping	1873	>>, it is definitely recommended to keep it off in production. Keeping
1794	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1874	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1795	can be very useful, however.	1875	can be very useful, however.
1796		1876
1797	=item C<PERL_ANYEVENT_MODEL>	1877	=item C<PERL_ANYEVENT_MODEL>
…		…
2019		2099
2020	The actual code goes further and collects all errors (C<die>s, exceptions)	2100	The actual code goes further and collects all errors (C<die>s, exceptions)
2021	that occurred during request processing. The C<result> method detects	2101	that occurred during request processing. The C<result> method detects
2022	whether an exception as thrown (it is stored inside the $txn object)	2102	whether an exception as thrown (it is stored inside the $txn object)
2023	and just throws the exception, which means connection errors and other	2103	and just throws the exception, which means connection errors and other
2024	problems get reported tot he code that tries to use the result, not in a	2104	problems get reported to the code that tries to use the result, not in a
2025	random callback.	2105	random callback.
2026		2106
2027	All of this enables the following usage styles:	2107	All of this enables the following usage styles:
2028		2108
2029	1. Blocking:	2109	1. Blocking:
…		…
2443	unless defined $SIG{PIPE};	2523	unless defined $SIG{PIPE};
2444		2524
2445	=head1 RECOMMENDED/OPTIONAL MODULES	2525	=head1 RECOMMENDED/OPTIONAL MODULES
2446		2526
2447	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2527	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2448	it's built-in modules) are required to use it.	2528	its built-in modules) are required to use it.
2449		2529
2450	That does not mean that AnyEvent won't take advantage of some additional	2530	That does not mean that AnyEvent won't take advantage of some additional
2451	modules if they are installed.	2531	modules if they are installed.
2452		2532
2453	This section explains which additional modules will be used, and how they	2533	This section explains which additional modules will be used, and how they
…		…
2486	automatic timer adjustments even when no monotonic clock is available,	2566	automatic timer adjustments even when no monotonic clock is available,
2487	can take avdantage of advanced kernel interfaces such as C<epoll> and	2567	can take avdantage of advanced kernel interfaces such as C<epoll> and
2488	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2568	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2489	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2569	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2490		2570
		2571	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2572	then this module will do nothing for you.
		2573
2491	=item L<Guard>	2574	=item L<Guard>
2492		2575
2493	The guard module, when used, will be used to implement	2576	The guard module, when used, will be used to implement
2494	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2577	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2495	lot less memory), but otherwise doesn't affect guard operation much. It is	2578	lot less memory), but otherwise doesn't affect guard operation much. It is
2496	purely used for performance.	2579	purely used for performance.
2497		2580
2498	=item L<JSON> and L<JSON::XS>	2581	=item L<JSON> and L<JSON::XS>
2499		2582
2500	One of these modules is required when you want to read or write JSON data	2583	One of these modules is required when you want to read or write JSON data
2501	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2584	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2502	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2585	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2503
2504	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2505	installed.
2506		2586
2507	=item L<Net::SSLeay>	2587	=item L<Net::SSLeay>
2508		2588
2509	Implementing TLS/SSL in Perl is certainly interesting, but not very	2589	Implementing TLS/SSL in Perl is certainly interesting, but not very
2510	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2590	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2511	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2591	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2512		2592
2513	=item L<Time::HiRes>	2593	=item L<Time::HiRes>
2514		2594
2515	This module is part of perl since release 5.008. It will be used when the	2595	This module is part of perl since release 5.008. It will be used when the
2516	chosen event library does not come with a timing source on it's own. The	2596	chosen event library does not come with a timing source of its own. The
2517	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2597	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2518	try to use a monotonic clock for timing stability.	2598	try to use a monotonic clock for timing stability.
2519		2599
2520	=back	2600	=back
2521		2601
2522		2602
2523	=head1 FORK	2603	=head1 FORK
2524		2604
2525	Most event libraries are not fork-safe. The ones who are usually are	2605	Most event libraries are not fork-safe. The ones who are usually are
2526	because they rely on inefficient but fork-safe C<select> or C<poll>	2606	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2527	calls. Only L<EV> is fully fork-aware.	2607	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2608	are usually badly thought-out hacks that are incompatible with fork in
		2609	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2610	continue event-processing in both parent and child (or both, if you know
		2611	what you are doing).
2528		2612
2529	This means that, in general, you cannot fork and do event processing	2613	This means that, in general, you cannot fork and do event processing in
2530	in the child if a watcher was created before the fork (which in turn	2614	the child if the event library was initialised before the fork (which
2531	initialises the event library).	2615	usually happens when the first AnyEvent watcher is created, or the library
		2616	is loaded).
2532		2617
2533	If you have to fork, you must either do so I<before> creating your first	2618	If you have to fork, you must either do so I<before> creating your first
2534	watcher OR you must not use AnyEvent at all in the child OR you must do	2619	watcher OR you must not use AnyEvent at all in the child OR you must do
2535	something completely out of the scope of AnyEvent.	2620	something completely out of the scope of AnyEvent.
2536		2621
2537	The problem of doing event processing in the parent I<and> the child	2622	The problem of doing event processing in the parent I<and> the child
2538	is much more complicated: even for backends that I<are> fork-aware or	2623	is much more complicated: even for backends that I<are> fork-aware or
2539	fork-safe, their behaviour is not usually what you want: fork clones all	2624	fork-safe, their behaviour is not usually what you want: fork clones all
2540	watchers, that means all timers, I/O watchers etc. are active in both	2625	watchers, that means all timers, I/O watchers etc. are active in both
2541	parent and child, which is almost never what you want.	2626	parent and child, which is almost never what you want. USing C<exec>
		2627	to start worker children from some kind of manage rprocess is usually
		2628	preferred, because it is much easier and cleaner, at the expense of having
		2629	to have another binary.
2542		2630
2543		2631
2544	=head1 SECURITY CONSIDERATIONS	2632	=head1 SECURITY CONSIDERATIONS
2545		2633
2546	AnyEvent can be forced to load any event model via	2634	AnyEvent can be forced to load any event model via
…		…
2576	pronounced).	2664	pronounced).
2577		2665
2578		2666
2579	=head1 SEE ALSO	2667	=head1 SEE ALSO
2580		2668
		2669	Tutorial/Introduction: L<AnyEvent::Intro>.
		2670
		2671	FAQ: L<AnyEvent::FAQ>.
		2672
2581	Utility functions: L<AnyEvent::Util>.	2673	Utility functions: L<AnyEvent::Util>.
2582		2674
2583	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2675	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
2584	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2676	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2585		2677
…		…
2591	Non-blocking file handles, sockets, TCP clients and	2683	Non-blocking file handles, sockets, TCP clients and
2592	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2684	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2593		2685
2594	Asynchronous DNS: L<AnyEvent::DNS>.	2686	Asynchronous DNS: L<AnyEvent::DNS>.
2595		2687
2596	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2688	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2597	L<Coro::Event>,
2598		2689
2599	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2690	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2600	L<AnyEvent::HTTP>.	2691	L<AnyEvent::HTTP>.
2601		2692
2602		2693
2603	=head1 AUTHOR	2694	=head1 AUTHOR
2604		2695

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.301 by root, Tue Dec 1 18:04:21 2009 UTC vs. Revision 1.340 by root, Fri Dec 3 18:39:06 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.301 by root, Tue Dec 1 18:04:21 2009 UTC vs.
Revision 1.340 by root, Fri Dec 3 18:39:06 2010 UTC