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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC vs.
Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC

…		…
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18		21
19	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21		24
22	# POSIX signal	25	# POSIX signal
…		…
43	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
45		48
46	=head1 SUPPORT	49	=head1 SUPPORT
47		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	53	There also is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	54	channel, too.
50		55
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	56	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Repository>, at L<http://anyevent.schmorp.de>, for more info.	57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		58
…		…
73	module users into the same thing by forcing them to use the same event	78	module users into the same thing by forcing them to use the same event
74	model you use.	79	model you use.
75		80
76	For modules like POE or IO::Async (which is a total misnomer as it is	81	For modules like POE or IO::Async (which is a total misnomer as it is
77	actually doing all I/O I<synchronously>...), using them in your module is	82	actually doing all I/O I<synchronously>...), using them in your module is
78	like joining a cult: After you joined, you are dependent on them and you	83	like joining a cult: After you join, you are dependent on them and you
79	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
80	that isn't them. What's worse, all the potential users of your	85	that isn't them. What's worse, all the potential users of your
81	module are I<also> forced to use the same event loop you use.	86	module are I<also> forced to use the same event loop you use.
82		87
83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
85	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
86	your module uses one of those, every user of your module has to use it,	91	uses one of those, every user of your module has to use it, too. But if
87	too. But if your module uses AnyEvent, it works transparently with all	92	your module uses AnyEvent, it works transparently with all event models it
88	event models it supports (including stuff like IO::Async, as long as those	93	supports (including stuff like IO::Async, as long as those use one of the
89	use one of the supported event loops. It is trivial to add new event loops	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
90	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
91		96
92	In addition to being free of having to use I<the one and only true event	97	In addition to being free of having to use I<the one and only true event
93	model>, AnyEvent also is free of bloat and policy: with POE or similar	98	model>, AnyEvent also is free of bloat and policy: with POE or similar
94	modules, you get an enormous amount of code and strict rules you have to	99	modules, you get an enormous amount of code and strict rules you have to
95	follow. AnyEvent, on the other hand, is lean and up to the point, by only	100	follow. AnyEvent, on the other hand, is lean and to the point, by only
96	offering the functionality that is necessary, in as thin as a wrapper as	101	offering the functionality that is necessary, in as thin as a wrapper as
97	technically possible.	102	technically possible.
98		103
99	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
100	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
106	useful) and you want to force your users to use the one and only event	111	useful) and you want to force your users to use the one and only event
107	model, you should I<not> use this module.	112	model, you should I<not> use this module.
108		113
109	=head1 DESCRIPTION	114	=head1 DESCRIPTION
110		115
111	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
112	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
113	users to use the same event loop (as only a single event loop can coexist	118	module users to use a specific event loop implementation (since more
114	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
115		120
116	The interface itself is vaguely similar, but not identical to the L<Event>	121	The interface itself is vaguely similar, but not identical to the L<Event>
117	module.	122	module.
118		123
119	During the first call of any watcher-creation method, the module tries	124	During the first call of any watcher-creation method, the module tries
120	to detect the currently loaded event loop by probing whether one of the	125	to detect the currently loaded event loop by probing whether one of the
121	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::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	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
…		…
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 implementation, 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.
860		883
861	=item Backends with special needs.	884	=item Backends with special needs.
862		885
863	Qt requires the Qt::Application to be instantiated first, but will	886	Qt requires the Qt::Application to be instantiated first, but will
864	otherwise be picked up automatically. As long as the main program	887	otherwise be picked up automatically. As long as the main program
865	instantiates the application before any AnyEvent watchers are created,	888	instantiates the application before any AnyEvent watchers are created,
866	everything should just work.	889	everything should just work.
867		890
868	AnyEvent::Impl::Qt based on Qt.	891	AnyEvent::Impl::Qt based on Qt.
869		892
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.	893	=item Event loops that are indirectly supported via other backends.
879		894
880	Some event loops can be supported via other modules:	895	Some event loops can be supported via other modules:
881		896
882	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.	897	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	922	Contains C<undef> until the first watcher is being created, before the
908	backend has been autodetected.	923	backend has been autodetected.
909		924
910	Afterwards it contains the event model that is being used, which is the	925	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	926	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	927	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	928	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
914	will be C<urxvt::anyevent>).	929	will be C<urxvt::anyevent>).
915		930
916	=item AnyEvent::detect	931	=item AnyEvent::detect
917		932
918	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	933	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
919	if necessary. You should only call this function right before you would	934	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	935	have created an AnyEvent watcher anyway, that is, as late as possible at
921	runtime, and not e.g. while initialising of your module.	936	runtime, and not e.g. during initialisation of your module.
922		937
923	If you need to do some initialisation before AnyEvent watchers are	938	If you need to do some initialisation before AnyEvent watchers are
924	created, use C<post_detect>.	939	created, use C<post_detect>.
925		940
926	=item $guard = AnyEvent::post_detect { BLOCK }	941	=item $guard = AnyEvent::post_detect { BLOCK }
927		942
928	Arranges for the code block to be executed as soon as the event model is	943	Arranges for the code block to be executed as soon as the event model is
929	autodetected (or immediately if this has already happened).	944	autodetected (or immediately if that has already happened).
930		945
931	The block will be executed I<after> the actual backend has been detected	946	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	947	(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	948	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	949	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
943	that automatically removes the callback again when it is destroyed (or	958	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	959	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
945	a case where this is useful.	960	a case where this is useful.
946		961
947	Example: Create a watcher for the IO::AIO module and store it in	962	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.	963	C<$WATCHER>, but do so only do so after the event loop is initialised.
949		964
950	our WATCHER;	965	our WATCHER;
951		966
952	my $guard = AnyEvent::post_detect {	967	my $guard = AnyEvent::post_detect {
953	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	968	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
961	$WATCHER \|\|= $guard;	976	$WATCHER \|\|= $guard;
962		977
963	=item @AnyEvent::post_detect	978	=item @AnyEvent::post_detect
964		979
965	If there are any code references in this array (you can C<push> to it	980	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	981	before or after loading AnyEvent), then they will be called directly
967	the event loop has been chosen.	982	after the event loop has been chosen.
968		983
969	You should check C<$AnyEvent::MODEL> before adding to this array, though:	984	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	985	if it is defined then the event loop has already been detected, and the
971	array will be ignored.	986	array will be ignored.
972		987
…		…
1008	because it will stall the whole program, and the whole point of using	1023	because it will stall the whole program, and the whole point of using
1009	events is to stay interactive.	1024	events is to stay interactive.
1010		1025
1011	It is fine, however, to call C<< ->recv >> when the user of your module	1026	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	1027	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 >>	1028	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).	1029	freely, as the user of your module knows what she is doing. Always).
1015		1030
1016	=head1 WHAT TO DO IN THE MAIN PROGRAM	1031	=head1 WHAT TO DO IN THE MAIN PROGRAM
1017		1032
1018	There will always be a single main program - the only place that should	1033	There will always be a single main program - the only place that should
1019	dictate which event model to use.	1034	dictate which event model to use.
1020		1035
1021	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1036	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	1037	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.	1038	uses AnyEvent, but does not care which event loop is used, all it needs
		1039	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1040	available loop implementation.
1024		1041
1025	If the main program relies on a specific event model - for example, in	1042	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	1043	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	1044	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	1045	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	1046	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	1047	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.	1048	might choose the wrong one unless you load the correct one yourself.
1032		1049
1033	You can chose to use a pure-perl implementation by loading the	1050	You can chose to use a pure-perl implementation by loading the
1034	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1051	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
1035	everywhere, but letting AnyEvent chose the model is generally better.	1052	everywhere, but letting AnyEvent chose the model is generally better.
1036		1053
…		…
1054	=head1 OTHER MODULES	1071	=head1 OTHER MODULES
1055		1072
1056	The following is a non-exhaustive list of additional modules that use	1073	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	1074	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1058	modules and other event loops in the same program. Some of the modules	1075	modules and other event loops in the same program. Some of the modules
1059	come with AnyEvent, most are available via CPAN.	1076	come as part of AnyEvent, the others are available via CPAN.
1060		1077
1061	=over 4	1078	=over 4
1062		1079
1063	=item L<AnyEvent::Util>	1080	=item L<AnyEvent::Util>
1064		1081
1065	Contains various utility functions that replace often-used but blocking	1082	Contains various utility functions that replace often-used blocking
1066	functions such as C<inet_aton> by event-/callback-based versions.	1083	functions such as C<inet_aton> with event/callback-based versions.
1067		1084
1068	=item L<AnyEvent::Socket>	1085	=item L<AnyEvent::Socket>
1069		1086
1070	Provides various utility functions for (internet protocol) sockets,	1087	Provides various utility functions for (internet protocol) sockets,
1071	addresses and name resolution. Also functions to create non-blocking tcp	1088	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1073		1090
1074	=item L<AnyEvent::Handle>	1091	=item L<AnyEvent::Handle>
1075		1092
1076	Provide read and write buffers, manages watchers for reads and writes,	1093	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	1094	supports raw and formatted I/O, I/O queued and fully transparent and
1078	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1095	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1079		1096
1080	=item L<AnyEvent::DNS>	1097	=item L<AnyEvent::DNS>
1081		1098
1082	Provides rich asynchronous DNS resolver capabilities.	1099	Provides rich asynchronous DNS resolver capabilities.
1083		1100
		1101	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1102
		1103	Implement event-based interfaces to the protocols of the same name (for
		1104	the curious, IGS is the International Go Server and FCP is the Freenet
		1105	Client Protocol).
		1106
		1107	=item L<AnyEvent::Handle::UDP>
		1108
		1109	Here be danger!
		1110
		1111	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1112	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1113	its use of a stream-based API with a protocol that isn't streamable, that
		1114	the only way to improve it is to delete it.
		1115
		1116	It features data corruption (but typically only under load) and general
		1117	confusion. On top, the author is not only clueless about UDP but also
		1118	fact-resistant - some gems of his understanding: "connect doesn't work
		1119	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1120	packets", "I don't need to implement proper error checking as UDP doesn't
		1121	support error checking" and so on - he doesn't even understand what's
		1122	wrong with his module when it is explained to him.
		1123
1084	=item L<AnyEvent::HTTP>	1124	=item L<AnyEvent::DBI>
1085		1125
1086	A simple-to-use HTTP library that is capable of making a lot of concurrent	1126	Executes L<DBI> requests asynchronously in a proxy process for you,
1087	HTTP requests.	1127	notifying you in an event-based way when the operation is finished.
		1128
		1129	=item L<AnyEvent::AIO>
		1130
		1131	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1132	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1133	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1134	file I/O, and much more.
1088		1135
1089	=item L<AnyEvent::HTTPD>	1136	=item L<AnyEvent::HTTPD>
1090		1137
1091	Provides a simple web application server framework.	1138	A simple embedded webserver.
1092		1139
1093	=item L<AnyEvent::FastPing>	1140	=item L<AnyEvent::FastPing>
1094		1141
1095	The fastest ping in the west.	1142	The fastest ping in the west.
1096
1097	=item L<AnyEvent::DBI>
1098
1099	Executes L<DBI> requests asynchronously in a proxy process.
1100
1101	=item L<AnyEvent::AIO>
1102
1103	Truly asynchronous I/O, should be in the toolbox of every event
1104	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1105	together.
1106
1107	=item L<AnyEvent::BDB>
1108
1109	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1110	L<BDB> and AnyEvent together.
1111
1112	=item L<AnyEvent::GPSD>
1113
1114	A non-blocking interface to gpsd, a daemon delivering GPS information.
1115
1116	=item L<AnyEvent::IRC>
1117
1118	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1119
1120	=item L<AnyEvent::XMPP>
1121
1122	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1123	Net::XMPP2>.
1124
1125	=item L<AnyEvent::IGS>
1126
1127	A non-blocking interface to the Internet Go Server protocol (used by
1128	L<App::IGS>).
1129
1130	=item L<Net::FCP>
1131
1132	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1133	of AnyEvent.
1134
1135	=item L<Event::ExecFlow>
1136
1137	High level API for event-based execution flow control.
1138		1143
1139	=item L<Coro>	1144	=item L<Coro>
1140		1145
1141	Has special support for AnyEvent via L<Coro::AnyEvent>.	1146	Has special support for AnyEvent via L<Coro::AnyEvent>.
1142		1147
…		…
1146		1151
1147	package AnyEvent;	1152	package AnyEvent;
1148		1153
1149	# basically a tuned-down version of common::sense	1154	# basically a tuned-down version of common::sense
1150	sub common_sense {	1155	sub common_sense {
1151	# from common:.sense 1.0	1156	# from common:.sense 3.4
1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1157	${^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)	1158	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1154	$^H \|= 0x00000600;	1159	$^H \|= 0x00000600;
1155	}	1160	}
1156		1161
1157	BEGIN { AnyEvent::common_sense }	1162	BEGIN { AnyEvent::common_sense }
1158		1163
1159	use Carp ();	1164	use Carp ();
1160		1165
1161	our $VERSION = '5.23';	1166	our $VERSION = '5.31';
1162	our $MODEL;	1167	our $MODEL;
1163		1168
1164	our $AUTOLOAD;	1169	our $AUTOLOAD;
1165	our @ISA;	1170	our @ISA;
1166		1171
1167	our @REGISTRY;	1172	our @REGISTRY;
1168		1173
1169	our $VERBOSE;	1174	our $VERBOSE;
1170		1175
1171	BEGIN {	1176	BEGIN {
1172	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1177	require "AnyEvent/constants.pl";
		1178
1173	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1179	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1174		1180
1175	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1181	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1176	if ${^TAINT};	1182	if ${^TAINT};
1177		1183
1178	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1184	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1203	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1209	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1204	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1210	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1205	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1211	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1206	[Wx:: => AnyEvent::Impl::POE::],	1212	[Wx:: => AnyEvent::Impl::POE::],
1207	[Prima:: => AnyEvent::Impl::POE::],	1213	[Prima:: => AnyEvent::Impl::POE::],
1208	# IO::Async is just too broken - we would need workarounds for its
1209	# byzantine signal and broken child handling, among others.
1210	# IO::Async is rather hard to detect, as it doesn't have any
1211	# obvious default class.
1212	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1213	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],
1214	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1215	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1215	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1216	);	1216	);
1217		1217
1218	our %method = map +($_ => 1),	1218	our %method = map +($_ => 1),
1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1220		1220
1221	our @post_detect;	1221	our @post_detect;
1222		1222
1223	sub post_detect(&) {	1223	sub post_detect(&) {
1224	my ($cb) = @_;	1224	my ($cb) = @_;
1225		1225
1226	if ($MODEL) {
1227	$cb->();
1228
1229	undef
1230	} else {
1231	push @post_detect, $cb;	1226	push @post_detect, $cb;
1232		1227
1233	defined wantarray	1228	defined wantarray
1234	? bless \$cb, "AnyEvent::Util::postdetect"	1229	? bless \$cb, "AnyEvent::Util::postdetect"
1235	: ()	1230	: ()
1236	}
1237	}	1231	}
1238		1232
1239	sub AnyEvent::Util::postdetect::DESTROY {	1233	sub AnyEvent::Util::postdetect::DESTROY {
1240	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1234	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1241	}	1235	}
1242		1236
1243	sub detect() {	1237	sub detect() {
		1238	# free some memory
		1239	*detect = sub () { $MODEL };
		1240
		1241	local $!; # for good measure
		1242	local $SIG{__DIE__};
		1243
		1244	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1245	my $model = "AnyEvent::Impl::$1";
		1246	if (eval "require $model") {
		1247	$MODEL = $model;
		1248	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1249	} else {
		1250	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1251	}
		1252	}
		1253
		1254	# check for already loaded models
1244	unless ($MODEL) {	1255	unless ($MODEL) {
1245	local $SIG{__DIE__};	1256	for (@REGISTRY, @models) {
1246		1257	my ($package, $model) = @$_;
1247	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1258	if (${"$package\::VERSION"} > 0) {
1248	my $model = "AnyEvent::Impl::$1";
1249	if (eval "require $model") {	1259	if (eval "require $model") {
1250	$MODEL = $model;	1260	$MODEL = $model;
1251	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1261	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1252	} else {	1262	last;
1253	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1263	}
1254	}	1264	}
1255	}	1265	}
1256		1266
1257	# check for already loaded models
1258	unless ($MODEL) {	1267	unless ($MODEL) {
		1268	# try to autoload a model
1259	for (@REGISTRY, @models) {	1269	for (@REGISTRY, @models) {
1260	my ($package, $model) = @$_;	1270	my ($package, $model, $autoload) = @$_;
		1271	if (
		1272	$autoload
		1273	and eval "require $package"
1261	if (${"$package\::VERSION"} > 0) {	1274	and ${"$package\::VERSION"} > 0
1262	if (eval "require $model") {	1275	and eval "require $model"
		1276	) {
1263	$MODEL = $model;	1277	$MODEL = $model;
1264	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1278	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1265	last;	1279	last;
1266	}
1267	}	1280	}
1268	}	1281	}
1269		1282
1270	unless ($MODEL) {
1271	# try to autoload a model
1272	for (@REGISTRY, @models) {
1273	my ($package, $model, $autoload) = @$_;
1274	if (
1275	$autoload
1276	and eval "require $package"
1277	and ${"$package\::VERSION"} > 0
1278	and eval "require $model"
1279	) {
1280	$MODEL = $model;
1281	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1282	last;
1283	}
1284	}
1285
1286	$MODEL	1283	$MODEL
1287	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1284	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1288	}
1289	}	1285	}
1290
1291	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1292
1293	unshift @ISA, $MODEL;
1294
1295	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1296
1297	(shift @post_detect)->() while @post_detect;
1298	}	1286	}
		1287
		1288	@models = (); # free probe data
		1289
		1290	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1291	unshift @ISA, $MODEL;
		1292
		1293	# now nuke some methods that are overridden by the backend.
		1294	# SUPER is not allowed.
		1295	for (qw(time signal child idle)) {
		1296	undef &{"AnyEvent::Base::$_"}
		1297	if defined &{"$MODEL\::$_"};
		1298	}
		1299
		1300	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1301	eval { require AnyEvent::Strict };
		1302	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
		1303	if $@ && $VERBOSE;
		1304	}
		1305
		1306	(shift @post_detect)->() while @post_detect;
		1307
		1308	*post_detect = sub(&) {
		1309	shift->();
		1310
		1311	undef
		1312	};
1299		1313
1300	$MODEL	1314	$MODEL
1301	}	1315	}
1302		1316
1303	sub AUTOLOAD {	1317	sub AUTOLOAD {
1304	(my $func = $AUTOLOAD) =~ s/.*://;	1318	(my $func = $AUTOLOAD) =~ s/.*://;
1305		1319
1306	$method{$func}	1320	$method{$func}
1307	or Carp::croak "$func: not a valid method for AnyEvent objects";	1321	or Carp::croak "$func: not a valid AnyEvent class method";
1308		1322
1309	detect unless $MODEL;	1323	detect;
1310		1324
1311	my $class = shift;	1325	my $class = shift;
1312	$class->$func (@_);	1326	$class->$func (@_);
1313	}	1327	}
1314		1328
…		…
1331		1345
1332	=head1 SIMPLIFIED AE API	1346	=head1 SIMPLIFIED AE API
1333		1347
1334	Starting with version 5.0, AnyEvent officially supports a second, much	1348	Starting with version 5.0, AnyEvent officially supports a second, much
1335	simpler, API that is designed to reduce the calling, typing and memory	1349	simpler, API that is designed to reduce the calling, typing and memory
1336	overhead.	1350	overhead by using function call syntax and a fixed number of parameters.
1337		1351
1338	See the L<AE> manpage for details.	1352	See the L<AE> manpage for details.
1339		1353
1340	=cut	1354	=cut
1341		1355
1342	package AE;	1356	package AE;
1343		1357
1344	our $VERSION = $AnyEvent::VERSION;	1358	our $VERSION = $AnyEvent::VERSION;
		1359
		1360	# fall back to the main API by default - backends and AnyEvent::Base
		1361	# implementations can overwrite these.
1345		1362
1346	sub io($$$) {	1363	sub io($$$) {
1347	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1348	}	1365	}
1349		1366
…		…
1381		1398
1382	package AnyEvent::Base;	1399	package AnyEvent::Base;
1383		1400
1384	# default implementations for many methods	1401	# default implementations for many methods
1385		1402
1386	sub _time() {	1403	sub time {
		1404	eval q{ # poor man's autoloading {}
1387	# probe for availability of Time::HiRes	1405	# probe for availability of Time::HiRes
1388	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1389	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1390	*_time = \&Time::HiRes::time;	1408	*AE::time = \&Time::HiRes::time;
1391	# if (eval "use POSIX (); (POSIX::times())...	1409	# if (eval "use POSIX (); (POSIX::times())...
1392	} else {	1410	} else {
1393	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1394	*_time = sub { time }; # epic fail	1412	*AE::time = sub (){ time }; # epic fail
		1413	}
		1414
		1415	*time = sub { AE::time }; # different prototypes
1395	}	1416	};
		1417	die if $@;
1396		1418
1397	&_time	1419	&time
1398	}	1420	}
1399		1421
1400	sub time { _time }	1422	*now = \&time;
1401	sub now { _time }	1423
1402	sub now_update { }	1424	sub now_update { }
1403		1425
1404	# default implementation for ->condvar	1426	# default implementation for ->condvar
1405		1427
1406	sub condvar {	1428	sub condvar {
		1429	eval q{ # poor man's autoloading {}
		1430	*condvar = sub {
1407	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1432	};
		1433
		1434	*AE::cv = sub (;&) {
		1435	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1436	};
		1437	};
		1438	die if $@;
		1439
		1440	&condvar
1408	}	1441	}
1409		1442
1410	# default implementation for ->signal	1443	# default implementation for ->signal
1411		1444
1412	our $HAVE_ASYNC_INTERRUPT;	1445	our $HAVE_ASYNC_INTERRUPT;
…		…
1421		1454
1422	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1455	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1423	our (%SIG_ASY, %SIG_ASY_W);	1456	our (%SIG_ASY, %SIG_ASY_W);
1424	our ($SIG_COUNT, $SIG_TW);	1457	our ($SIG_COUNT, $SIG_TW);
1425		1458
1426	sub _signal_exec {
1427	$HAVE_ASYNC_INTERRUPT
1428	? $SIGPIPE_R->drain
1429	: sysread $SIGPIPE_R, (my $dummy), 9;
1430
1431	while (%SIG_EV) {
1432	for (keys %SIG_EV) {
1433	delete $SIG_EV{$_};
1434	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1435	}
1436	}
1437	}
1438
1439	# install a dummy wakeup watcher to reduce signal catching latency	1459	# install a dummy wakeup watcher to reduce signal catching latency
		1460	# used by Impls
1440	sub _sig_add() {	1461	sub _sig_add() {
1441	unless ($SIG_COUNT++) {	1462	unless ($SIG_COUNT++) {
1442	# try to align timer on a full-second boundary, if possible	1463	# try to align timer on a full-second boundary, if possible
1443	my $NOW = AE::now;	1464	my $NOW = AE::now;
1444		1465
…		…
1454	undef $SIG_TW	1475	undef $SIG_TW
1455	unless --$SIG_COUNT;	1476	unless --$SIG_COUNT;
1456	}	1477	}
1457		1478
1458	our $_sig_name_init; $_sig_name_init = sub {	1479	our $_sig_name_init; $_sig_name_init = sub {
1459	eval q{ # poor man's autoloading	1480	eval q{ # poor man's autoloading {}
1460	undef $_sig_name_init;	1481	undef $_sig_name_init;
1461		1482
1462	if (_have_async_interrupt) {	1483	if (_have_async_interrupt) {
1463	*sig2num = \&Async::Interrupt::sig2num;	1484	*sig2num = \&Async::Interrupt::sig2num;
1464	*sig2name = \&Async::Interrupt::sig2name;	1485	*sig2name = \&Async::Interrupt::sig2name;
…		…
1496	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1497		1518
1498	} else {	1519	} else {
1499	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1500		1521
1501	require Fcntl;
1502
1503	if (AnyEvent::WIN32) {	1522	if (AnyEvent::WIN32) {
1504	require AnyEvent::Util;	1523	require AnyEvent::Util;
1505		1524
1506	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1507	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1526	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1508	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1527	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1509	} else {	1528	} else {
1510	pipe $SIGPIPE_R, $SIGPIPE_W;	1529	pipe $SIGPIPE_R, $SIGPIPE_W;
1511	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1530	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1512	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1531	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1513		1532
1514	# not strictly required, as $^F is normally 2, but let's make sure...	1533	# not strictly required, as $^F is normally 2, but let's make sure...
1515	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1534	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1516	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1535	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1517	}	1536	}
1518		1537
1519	$SIGPIPE_R	1538	$SIGPIPE_R
1520	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1539	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1521		1540
1522	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1541	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1523	}	1542	}
1524		1543
1525	*signal = sub {	1544	*signal = $HAVE_ASYNC_INTERRUPT
		1545	? sub {
1526	my (undef, %arg) = @_;	1546	my (undef, %arg) = @_;
1527		1547
1528	my $signal = uc $arg{signal}
1529	or Carp::croak "required option 'signal' is missing";
1530
1531	if ($HAVE_ASYNC_INTERRUPT) {
1532	# async::interrupt	1548	# async::interrupt
1533
1534	$signal = sig2num $signal;	1549	my $signal = sig2num $arg{signal};
1535	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1550	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1536		1551
1537	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1552	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1538	cb => sub { undef $SIG_EV{$signal} },	1553	cb => sub { undef $SIG_EV{$signal} },
1539	signal => $signal,	1554	signal => $signal,
1540	pipe => [$SIGPIPE_R->filenos],	1555	pipe => [$SIGPIPE_R->filenos],
1541	pipe_autodrain => 0,	1556	pipe_autodrain => 0,
1542	;	1557	;
1543		1558
1544	} else {	1559	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1560	}
		1561	: sub {
		1562	my (undef, %arg) = @_;
		1563
1545	# pure perl	1564	# pure perl
1546
1547	# AE::Util has been loaded in signal
1548	$signal = sig2name $signal;	1565	my $signal = sig2name $arg{signal};
1549	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1566	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1550		1567
1551	$SIG{$signal} \|\|= sub {	1568	$SIG{$signal} \|\|= sub {
1552	local $!;	1569	local $!;
1553	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1570	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1554	undef $SIG_EV{$signal};	1571	undef $SIG_EV{$signal};
1555	};	1572	};
1556		1573
1557	# can't do signal processing without introducing races in pure perl,	1574	# can't do signal processing without introducing races in pure perl,
1558	# so limit the signal latency.	1575	# so limit the signal latency.
1559	_sig_add;	1576	_sig_add;
1560	}
1561		1577
1562	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1578	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1579	}
1563	};	1580	;
1564		1581
1565	*AnyEvent::Base::signal::DESTROY = sub {	1582	*AnyEvent::Base::signal::DESTROY = sub {
1566	my ($signal, $cb) = @{$_[0]};	1583	my ($signal, $cb) = @{$_[0]};
1567		1584
1568	_sig_del;	1585	_sig_del;
…		…
1575	# print weird messages, or just unconditionally exit	1592	# print weird messages, or just unconditionally exit
1576	# instead of getting the default action.	1593	# instead of getting the default action.
1577	undef $SIG{$signal}	1594	undef $SIG{$signal}
1578	unless keys %{ $SIG_CB{$signal} };	1595	unless keys %{ $SIG_CB{$signal} };
1579	};	1596	};
		1597
		1598	*_signal_exec = sub {
		1599	$HAVE_ASYNC_INTERRUPT
		1600	? $SIGPIPE_R->drain
		1601	: sysread $SIGPIPE_R, (my $dummy), 9;
		1602
		1603	while (%SIG_EV) {
		1604	for (keys %SIG_EV) {
		1605	delete $SIG_EV{$_};
		1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1607	}
		1608	}
		1609	};
1580	};	1610	};
1581	die if $@;	1611	die if $@;
		1612
1582	&signal	1613	&signal
1583	}	1614	}
1584		1615
1585	# default implementation for ->child	1616	# default implementation for ->child
1586		1617
1587	our %PID_CB;	1618	our %PID_CB;
1588	our $CHLD_W;	1619	our $CHLD_W;
1589	our $CHLD_DELAY_W;	1620	our $CHLD_DELAY_W;
1590	our $WNOHANG;
1591		1621
		1622	# used by many Impl's
1592	sub _emit_childstatus($$) {	1623	sub _emit_childstatus($$) {
1593	my (undef, $rpid, $rstatus) = @_;	1624	my (undef, $rpid, $rstatus) = @_;
1594		1625
1595	$_->($rpid, $rstatus)	1626	$_->($rpid, $rstatus)
1596	for values %{ $PID_CB{$rpid} \|\| {} },	1627	for values %{ $PID_CB{$rpid} \|\| {} },
1597	values %{ $PID_CB{0} \|\| {} };	1628	values %{ $PID_CB{0} \|\| {} };
1598	}	1629	}
1599		1630
1600	sub _sigchld {
1601	my $pid;
1602
1603	AnyEvent->_emit_childstatus ($pid, $?)
1604	while ($pid = waitpid -1, $WNOHANG) > 0;
1605	}
1606
1607	sub child {	1631	sub child {
		1632	eval q{ # poor man's autoloading {}
		1633	*_sigchld = sub {
		1634	my $pid;
		1635
		1636	AnyEvent->_emit_childstatus ($pid, $?)
		1637	while ($pid = waitpid -1, WNOHANG) > 0;
		1638	};
		1639
		1640	*child = sub {
1608	my (undef, %arg) = @_;	1641	my (undef, %arg) = @_;
1609		1642
1610	defined (my $pid = $arg{pid} + 0)	1643	defined (my $pid = $arg{pid} + 0)
1611	or Carp::croak "required option 'pid' is missing";	1644	or Carp::croak "required option 'pid' is missing";
1612		1645
1613	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1646	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1614		1647
1615	# WNOHANG is almost cetrainly 1 everywhere
1616	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1617	? 1
1618	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1619
1620	unless ($CHLD_W) {	1648	unless ($CHLD_W) {
1621	$CHLD_W = AE::signal CHLD => \&_sigchld;	1649	$CHLD_W = AE::signal CHLD => \&_sigchld;
1622	# child could be a zombie already, so make at least one round	1650	# child could be a zombie already, so make at least one round
1623	&_sigchld;	1651	&_sigchld;
1624	}	1652	}
1625		1653
1626	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1627	}	1655	};
1628		1656
1629	sub AnyEvent::Base::child::DESTROY {	1657	*AnyEvent::Base::child::DESTROY = sub {
1630	my ($pid, $cb) = @{$_[0]};	1658	my ($pid, $cb) = @{$_[0]};
1631		1659
1632	delete $PID_CB{$pid}{$cb};	1660	delete $PID_CB{$pid}{$cb};
1633	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1634		1662
1635	undef $CHLD_W unless keys %PID_CB;	1663	undef $CHLD_W unless keys %PID_CB;
		1664	};
		1665	};
		1666	die if $@;
		1667
		1668	&child
1636	}	1669	}
1637		1670
1638	# idle emulation is done by simply using a timer, regardless	1671	# idle emulation is done by simply using a timer, regardless
1639	# of whether the process is idle or not, and not letting	1672	# of whether the process is idle or not, and not letting
1640	# the callback use more than 50% of the time.	1673	# the callback use more than 50% of the time.
1641	sub idle {	1674	sub idle {
		1675	eval q{ # poor man's autoloading {}
		1676	*idle = sub {
1642	my (undef, %arg) = @_;	1677	my (undef, %arg) = @_;
1643		1678
1644	my ($cb, $w, $rcb) = $arg{cb};	1679	my ($cb, $w, $rcb) = $arg{cb};
1645		1680
1646	$rcb = sub {	1681	$rcb = sub {
1647	if ($cb) {	1682	if ($cb) {
1648	$w = _time;	1683	$w = _time;
1649	&$cb;	1684	&$cb;
1650	$w = _time - $w;	1685	$w = _time - $w;
1651		1686
1652	# never use more then 50% of the time for the idle watcher,	1687	# never use more then 50% of the time for the idle watcher,
1653	# within some limits	1688	# within some limits
1654	$w = 0.0001 if $w < 0.0001;	1689	$w = 0.0001 if $w < 0.0001;
1655	$w = 5 if $w > 5;	1690	$w = 5 if $w > 5;
1656		1691
1657	$w = AE::timer $w, 0, $rcb;	1692	$w = AE::timer $w, 0, $rcb;
1658	} else {	1693	} else {
1659	# clean up...	1694	# clean up...
1660	undef $w;	1695	undef $w;
1661	undef $rcb;	1696	undef $rcb;
		1697	}
		1698	};
		1699
		1700	$w = AE::timer 0.05, 0, $rcb;
		1701
		1702	bless \\$cb, "AnyEvent::Base::idle"
1662	}	1703	};
		1704
		1705	*AnyEvent::Base::idle::DESTROY = sub {
		1706	undef $${$_[0]};
		1707	};
1663	};	1708	};
		1709	die if $@;
1664		1710
1665	$w = AE::timer 0.05, 0, $rcb;	1711	&idle
1666
1667	bless \\$cb, "AnyEvent::Base::idle"
1668	}
1669
1670	sub AnyEvent::Base::idle::DESTROY {
1671	undef $${$_[0]};
1672	}	1712	}
1673		1713
1674	package AnyEvent::CondVar;	1714	package AnyEvent::CondVar;
1675		1715
1676	our @ISA = AnyEvent::CondVar::Base::;	1716	our @ISA = AnyEvent::CondVar::Base::;
		1717
		1718	# only to be used for subclassing
		1719	sub new {
		1720	my $class = shift;
		1721	bless AnyEvent->condvar (@_), $class
		1722	}
1677		1723
1678	package AnyEvent::CondVar::Base;	1724	package AnyEvent::CondVar::Base;
1679		1725
1680	#use overload	1726	#use overload
1681	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1727	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
…		…
1803	check the arguments passed to most method calls. If it finds any problems,	1849	check the arguments passed to most method calls. If it finds any problems,
1804	it will croak.	1850	it will croak.
1805		1851
1806	In other words, enables "strict" mode.	1852	In other words, enables "strict" mode.
1807		1853
1808	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	1854	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1809	>>, it is definitely recommended to keep it off in production. Keeping	1855	>>, it is definitely recommended to keep it off in production. Keeping
1810	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1856	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1811	can be very useful, however.	1857	can be very useful, however.
1812		1858
1813	=item C<PERL_ANYEVENT_MODEL>	1859	=item C<PERL_ANYEVENT_MODEL>
…		…
2035		2081
2036	The actual code goes further and collects all errors (C<die>s, exceptions)	2082	The actual code goes further and collects all errors (C<die>s, exceptions)
2037	that occurred during request processing. The C<result> method detects	2083	that occurred during request processing. The C<result> method detects
2038	whether an exception as thrown (it is stored inside the $txn object)	2084	whether an exception as thrown (it is stored inside the $txn object)
2039	and just throws the exception, which means connection errors and other	2085	and just throws the exception, which means connection errors and other
2040	problems get reported tot he code that tries to use the result, not in a	2086	problems get reported to the code that tries to use the result, not in a
2041	random callback.	2087	random callback.
2042		2088
2043	All of this enables the following usage styles:	2089	All of this enables the following usage styles:
2044		2090
2045	1. Blocking:	2091	1. Blocking:
…		…
2459	unless defined $SIG{PIPE};	2505	unless defined $SIG{PIPE};
2460		2506
2461	=head1 RECOMMENDED/OPTIONAL MODULES	2507	=head1 RECOMMENDED/OPTIONAL MODULES
2462		2508
2463	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2509	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2464	it's built-in modules) are required to use it.	2510	its built-in modules) are required to use it.
2465		2511
2466	That does not mean that AnyEvent won't take advantage of some additional	2512	That does not mean that AnyEvent won't take advantage of some additional
2467	modules if they are installed.	2513	modules if they are installed.
2468		2514
2469	This section explains which additional modules will be used, and how they	2515	This section explains which additional modules will be used, and how they
…		…
2502	automatic timer adjustments even when no monotonic clock is available,	2548	automatic timer adjustments even when no monotonic clock is available,
2503	can take avdantage of advanced kernel interfaces such as C<epoll> and	2549	can take avdantage of advanced kernel interfaces such as C<epoll> and
2504	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2550	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2505	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2551	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2506		2552
		2553	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2554	then this module will do nothing for you.
		2555
2507	=item L<Guard>	2556	=item L<Guard>
2508		2557
2509	The guard module, when used, will be used to implement	2558	The guard module, when used, will be used to implement
2510	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2559	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2511	lot less memory), but otherwise doesn't affect guard operation much. It is	2560	lot less memory), but otherwise doesn't affect guard operation much. It is
2512	purely used for performance.	2561	purely used for performance.
2513		2562
2514	=item L<JSON> and L<JSON::XS>	2563	=item L<JSON> and L<JSON::XS>
2515		2564
2516	One of these modules is required when you want to read or write JSON data	2565	One of these modules is required when you want to read or write JSON data
2517	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2566	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2518	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2567	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2519
2520	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2521	installed.
2522		2568
2523	=item L<Net::SSLeay>	2569	=item L<Net::SSLeay>
2524		2570
2525	Implementing TLS/SSL in Perl is certainly interesting, but not very	2571	Implementing TLS/SSL in Perl is certainly interesting, but not very
2526	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2572	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2527	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2573	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2528		2574
2529	=item L<Time::HiRes>	2575	=item L<Time::HiRes>
2530		2576
2531	This module is part of perl since release 5.008. It will be used when the	2577	This module is part of perl since release 5.008. It will be used when the
2532	chosen event library does not come with a timing source on it's own. The	2578	chosen event library does not come with a timing source of its own. The
2533	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2579	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2534	try to use a monotonic clock for timing stability.	2580	try to use a monotonic clock for timing stability.
2535		2581
2536	=back	2582	=back
2537		2583
…		…
2600	pronounced).	2646	pronounced).
2601		2647
2602		2648
2603	=head1 SEE ALSO	2649	=head1 SEE ALSO
2604		2650
		2651	Tutorial/Introduction: L<AnyEvent::Intro>.
		2652
		2653	FAQ: L<AnyEvent::FAQ>.
		2654
2605	Utility functions: L<AnyEvent::Util>.	2655	Utility functions: L<AnyEvent::Util>.
2606		2656
2607	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2657	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
2608	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2609		2659
…		…
2615	Non-blocking file handles, sockets, TCP clients and	2665	Non-blocking file handles, sockets, TCP clients and
2616	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2666	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2617		2667
2618	Asynchronous DNS: L<AnyEvent::DNS>.	2668	Asynchronous DNS: L<AnyEvent::DNS>.
2619		2669
2620	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2670	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2621	L<Coro::Event>,
2622		2671
2623	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2672	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2624	L<AnyEvent::HTTP>.	2673	L<AnyEvent::HTTP>.
2625		2674
2626		2675
2627	=head1 AUTHOR	2676	=head1 AUTHOR
2628		2677

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC vs. Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC vs.
Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC