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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.315 by root, Sat Mar 13 00:08:08 2010 UTC vs.
Revision 1.338 by root, Tue Nov 23 04:45:59 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	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
…		…
869		890
870	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
871	architecturally limited to even support the AnyEvent API. It also	892	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	893	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	894	it can only be used by a main program knowing about AnyEvent. See
874	L<AnyEvent::Impl::Async> for the gory details.	895	L<AnyEvent::Impl::IOAsync> for the gory details.
875		896
876	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.	897	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
877		898
878	=item Event loops that are indirectly supported via other backends.	899	=item Event loops that are indirectly supported via other backends.
879		900
…		…
907	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
908	backend has been autodetected.	929	backend has been autodetected.
909		930
910	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
911	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
912	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
913	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
914	will be C<urxvt::anyevent>).	935	will be C<urxvt::anyevent>).
915		936
916	=item AnyEvent::detect	937	=item AnyEvent::detect
917		938
918	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	939	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
919	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
920	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
921	runtime, and not e.g. while initialising of your module.	942	runtime, and not e.g. during initialisation of your module.
922		943
923	If you need to do some initialisation before AnyEvent watchers are	944	If you need to do some initialisation before AnyEvent watchers are
924	created, use C<post_detect>.	945	created, use C<post_detect>.
925		946
926	=item $guard = AnyEvent::post_detect { BLOCK }	947	=item $guard = AnyEvent::post_detect { BLOCK }
927		948
928	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
929	autodetected (or immediately if this has already happened).	950	autodetected (or immediately if that has already happened).
930		951
931	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
932	(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
933	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
934	other initialisations - see the sources of L<AnyEvent::Strict> or	955	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
943	that automatically removes the callback again when it is destroyed (or	964	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	965	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
945	a case where this is useful.	966	a case where this is useful.
946		967
947	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
948	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.
949		970
950	our WATCHER;	971	our WATCHER;
951		972
952	my $guard = AnyEvent::post_detect {	973	my $guard = AnyEvent::post_detect {
953	$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);
…		…
961	$WATCHER \|\|= $guard;	982	$WATCHER \|\|= $guard;
962		983
963	=item @AnyEvent::post_detect	984	=item @AnyEvent::post_detect
964		985
965	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
966	before or after loading AnyEvent), then they will called directly after	987	before or after loading AnyEvent), then they will be called directly
967	the event loop has been chosen.	988	after the event loop has been chosen.
968		989
969	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:
970	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
971	array will be ignored.	992	array will be ignored.
972		993
…		…
1008	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
1009	events is to stay interactive.	1030	events is to stay interactive.
1010		1031
1011	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
1012	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
1013	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 >>
1014	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).
1015		1036
1016	=head1 WHAT TO DO IN THE MAIN PROGRAM	1037	=head1 WHAT TO DO IN THE MAIN PROGRAM
1017		1038
1018	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
1019	dictate which event model to use.	1040	dictate which event model to use.
1020		1041
1021	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
1022	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
1023	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.
1024		1047
1025	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
1026	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
1027	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
1028	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
1029	modules might create watchers when they are loaded, and AnyEvent will	1052	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	1053	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.	1054	might choose the wrong one unless you load the correct one yourself.
1032		1055
1033	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
1034	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1057	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
1035	everywhere, but letting AnyEvent chose the model is generally better.	1058	everywhere, but letting AnyEvent chose the model is generally better.
1036		1059
…		…
1054	=head1 OTHER MODULES	1077	=head1 OTHER MODULES
1055		1078
1056	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
1057	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
1058	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
1059	come with AnyEvent, most are available via CPAN.	1082	come as part of AnyEvent, the others are available via CPAN.
1060		1083
1061	=over 4	1084	=over 4
1062		1085
1063	=item L<AnyEvent::Util>	1086	=item L<AnyEvent::Util>
1064		1087
1065	Contains various utility functions that replace often-used but blocking	1088	Contains various utility functions that replace often-used blocking
1066	functions such as C<inet_aton> by event-/callback-based versions.	1089	functions such as C<inet_aton> with event/callback-based versions.
1067		1090
1068	=item L<AnyEvent::Socket>	1091	=item L<AnyEvent::Socket>
1069		1092
1070	Provides various utility functions for (internet protocol) sockets,	1093	Provides various utility functions for (internet protocol) sockets,
1071	addresses and name resolution. Also functions to create non-blocking tcp	1094	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1073		1096
1074	=item L<AnyEvent::Handle>	1097	=item L<AnyEvent::Handle>
1075		1098
1076	Provide read and write buffers, manages watchers for reads and writes,	1099	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	1100	supports raw and formatted I/O, I/O queued and fully transparent and
1078	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1101	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1079		1102
1080	=item L<AnyEvent::DNS>	1103	=item L<AnyEvent::DNS>
1081		1104
1082	Provides rich asynchronous DNS resolver capabilities.	1105	Provides rich asynchronous DNS resolver capabilities.
1083		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
1084	=item L<AnyEvent::HTTP>	1130	=item L<AnyEvent::DBI>
1085		1131
1086	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,
1087	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.
1088		1141
1089	=item L<AnyEvent::HTTPD>	1142	=item L<AnyEvent::HTTPD>
1090		1143
1091	Provides a simple web application server framework.	1144	A simple embedded webserver.
1092		1145
1093	=item L<AnyEvent::FastPing>	1146	=item L<AnyEvent::FastPing>
1094		1147
1095	The fastest ping in the west.	1148	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		1149
1139	=item L<Coro>	1150	=item L<Coro>
1140		1151
1141	Has special support for AnyEvent via L<Coro::AnyEvent>.	1152	Has special support for AnyEvent via L<Coro::AnyEvent>.
1142		1153
…		…
1146		1157
1147	package AnyEvent;	1158	package AnyEvent;
1148		1159
1149	# basically a tuned-down version of common::sense	1160	# basically a tuned-down version of common::sense
1150	sub common_sense {	1161	sub common_sense {
1151	# from common:.sense 1.0	1162	# from common:.sense 3.3
1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1163	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";
1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)	1164	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1154	$^H \|= 0x00000600;	1165	$^H \|= 0x00000600;
1155	}	1166	}
1156		1167
1157	BEGIN { AnyEvent::common_sense }	1168	BEGIN { AnyEvent::common_sense }
1158		1169
1159	use Carp ();	1170	use Carp ();
1160		1171
1161	our $VERSION = '5.251';	1172	our $VERSION = '5.29';
1162	our $MODEL;	1173	our $MODEL;
1163		1174
1164	our $AUTOLOAD;	1175	our $AUTOLOAD;
1165	our @ISA;	1176	our @ISA;
1166		1177
…		…
1169	our $VERBOSE;	1180	our $VERBOSE;
1170		1181
1171	BEGIN {	1182	BEGIN {
1172	require "AnyEvent/constants.pl";	1183	require "AnyEvent/constants.pl";
1173		1184
1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";	1185	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1175		1186
1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1187	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1177	if ${^TAINT};	1188	if ${^TAINT};
1178		1189
1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1190	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1222	our @post_detect;	1233	our @post_detect;
1223		1234
1224	sub post_detect(&) {	1235	sub post_detect(&) {
1225	my ($cb) = @_;	1236	my ($cb) = @_;
1226		1237
1227	if ($MODEL) {
1228	$cb->();
1229
1230	undef
1231	} else {
1232	push @post_detect, $cb;	1238	push @post_detect, $cb;
1233		1239
1234	defined wantarray	1240	defined wantarray
1235	? bless \$cb, "AnyEvent::Util::postdetect"	1241	? bless \$cb, "AnyEvent::Util::postdetect"
1236	: ()	1242	: ()
1237	}
1238	}	1243	}
1239		1244
1240	sub AnyEvent::Util::postdetect::DESTROY {	1245	sub AnyEvent::Util::postdetect::DESTROY {
1241	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1246	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1242	}	1247	}
…		…
1286	last;	1291	last;
1287	}	1292	}
1288	}	1293	}
1289		1294
1290	$MODEL	1295	$MODEL
1291	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";
1292	}	1297	}
1293	}	1298	}
1294		1299
1295	@models = (); # free probe data	1300	@models = (); # free probe data
1296		1301
1297	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1298	unshift @ISA, $MODEL;	1303	unshift @ISA, $MODEL;
1299		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
1300	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1312	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1301		1313
1302	(shift @post_detect)->() while @post_detect;	1314	(shift @post_detect)->() while @post_detect;
		1315
		1316	*post_detect = sub(&) {
		1317	shift->();
		1318
		1319	undef
		1320	};
1303		1321
1304	$MODEL	1322	$MODEL
1305	}	1323	}
1306		1324
1307	sub AUTOLOAD {	1325	sub AUTOLOAD {
…		…
1335		1353
1336	=head1 SIMPLIFIED AE API	1354	=head1 SIMPLIFIED AE API
1337		1355
1338	Starting with version 5.0, AnyEvent officially supports a second, much	1356	Starting with version 5.0, AnyEvent officially supports a second, much
1339	simpler, API that is designed to reduce the calling, typing and memory	1357	simpler, API that is designed to reduce the calling, typing and memory
1340	overhead.	1358	overhead by using function call syntax and a fixed number of parameters.
1341		1359
1342	See the L<AE> manpage for details.	1360	See the L<AE> manpage for details.
1343		1361
1344	=cut	1362	=cut
1345		1363
1346	package AE;	1364	package AE;
1347		1365
1348	our $VERSION = $AnyEvent::VERSION;	1366	our $VERSION = $AnyEvent::VERSION;
		1367
		1368	# fall back to the main API by default - backends and AnyEvent::Base
		1369	# implementations can overwrite these.
1349		1370
1350	sub io($$$) {	1371	sub io($$$) {
1351	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1372	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1352	}	1373	}
1353		1374
…		…
1385		1406
1386	package AnyEvent::Base;	1407	package AnyEvent::Base;
1387		1408
1388	# default implementations for many methods	1409	# default implementations for many methods
1389		1410
1390	sub _time() {	1411	sub time {
1391	eval q{ # poor man's autoloading	1412	eval q{ # poor man's autoloading {}
1392	# probe for availability of Time::HiRes	1413	# probe for availability of Time::HiRes
1393	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1414	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1394	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1415	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1395	*_time = \&Time::HiRes::time;	1416	*AE::time = \&Time::HiRes::time;
1396	# if (eval "use POSIX (); (POSIX::times())...	1417	# if (eval "use POSIX (); (POSIX::times())...
1397	} else {	1418	} else {
1398	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1419	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1399	*_time = sub (){ time }; # epic fail	1420	*AE::time = sub (){ time }; # epic fail
1400	}	1421	}
		1422
		1423	*time = sub { AE::time }; # different prototypes
1401	};	1424	};
1402	die if $@;	1425	die if $@;
1403		1426
1404	&_time	1427	&time
1405	}	1428	}
1406		1429
1407	sub time { _time }	1430	*now = \&time;
1408	sub now { _time }	1431
1409	sub now_update { }	1432	sub now_update { }
1410		1433
1411	# default implementation for ->condvar	1434	# default implementation for ->condvar
1412		1435
1413	sub condvar {	1436	sub condvar {
		1437	eval q{ # poor man's autoloading {}
		1438	*condvar = sub {
1414	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1439	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1440	};
		1441
		1442	*AE::cv = sub (;&) {
		1443	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1444	};
		1445	};
		1446	die if $@;
		1447
		1448	&condvar
1415	}	1449	}
1416		1450
1417	# default implementation for ->signal	1451	# default implementation for ->signal
1418		1452
1419	our $HAVE_ASYNC_INTERRUPT;	1453	our $HAVE_ASYNC_INTERRUPT;
…		…
1449	undef $SIG_TW	1483	undef $SIG_TW
1450	unless --$SIG_COUNT;	1484	unless --$SIG_COUNT;
1451	}	1485	}
1452		1486
1453	our $_sig_name_init; $_sig_name_init = sub {	1487	our $_sig_name_init; $_sig_name_init = sub {
1454	eval q{ # poor man's autoloading	1488	eval q{ # poor man's autoloading {}
1455	undef $_sig_name_init;	1489	undef $_sig_name_init;
1456		1490
1457	if (_have_async_interrupt) {	1491	if (_have_async_interrupt) {
1458	*sig2num = \&Async::Interrupt::sig2num;	1492	*sig2num = \&Async::Interrupt::sig2num;
1459	*sig2name = \&Async::Interrupt::sig2name;	1493	*sig2name = \&Async::Interrupt::sig2name;
…		…
1513	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1547	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1514		1548
1515	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1549	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1516	}	1550	}
1517		1551
1518	*signal = sub {	1552	*signal = $HAVE_ASYNC_INTERRUPT
		1553	? sub {
1519	my (undef, %arg) = @_;	1554	my (undef, %arg) = @_;
1520		1555
1521	my $signal = uc $arg{signal}
1522	or Carp::croak "required option 'signal' is missing";
1523
1524	if ($HAVE_ASYNC_INTERRUPT) {
1525	# async::interrupt	1556	# async::interrupt
1526
1527	$signal = sig2num $signal;	1557	my $signal = sig2num $arg{signal};
1528	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1558	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1529		1559
1530	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1560	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1531	cb => sub { undef $SIG_EV{$signal} },	1561	cb => sub { undef $SIG_EV{$signal} },
1532	signal => $signal,	1562	signal => $signal,
1533	pipe => [$SIGPIPE_R->filenos],	1563	pipe => [$SIGPIPE_R->filenos],
1534	pipe_autodrain => 0,	1564	pipe_autodrain => 0,
1535	;	1565	;
1536		1566
1537	} else {	1567	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1568	}
		1569	: sub {
		1570	my (undef, %arg) = @_;
		1571
1538	# pure perl	1572	# pure perl
1539
1540	# AE::Util has been loaded in signal
1541	$signal = sig2name $signal;	1573	my $signal = sig2name $arg{signal};
1542	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1574	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1543		1575
1544	$SIG{$signal} \|\|= sub {	1576	$SIG{$signal} \|\|= sub {
1545	local $!;	1577	local $!;
1546	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1578	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1547	undef $SIG_EV{$signal};	1579	undef $SIG_EV{$signal};
1548	};	1580	};
1549		1581
1550	# can't do signal processing without introducing races in pure perl,	1582	# can't do signal processing without introducing races in pure perl,
1551	# so limit the signal latency.	1583	# so limit the signal latency.
1552	_sig_add;	1584	_sig_add;
1553	}
1554		1585
1555	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1586	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1587	}
1556	};	1588	;
1557		1589
1558	*AnyEvent::Base::signal::DESTROY = sub {	1590	*AnyEvent::Base::signal::DESTROY = sub {
1559	my ($signal, $cb) = @{$_[0]};	1591	my ($signal, $cb) = @{$_[0]};
1560		1592
1561	_sig_del;	1593	_sig_del;
…		…
1695		1727
1696	package AnyEvent::CondVar;	1728	package AnyEvent::CondVar;
1697		1729
1698	our @ISA = AnyEvent::CondVar::Base::;	1730	our @ISA = AnyEvent::CondVar::Base::;
1699		1731
		1732	# only to be used for subclassing
		1733	sub new {
		1734	my $class = shift;
		1735	bless AnyEvent->condvar (@_), $class
		1736	}
		1737
1700	package AnyEvent::CondVar::Base;	1738	package AnyEvent::CondVar::Base;
1701		1739
1702	#use overload	1740	#use overload
1703	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1741	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1704	# fallback => 1;	1742	# fallback => 1;
…		…
1825	check the arguments passed to most method calls. If it finds any problems,	1863	check the arguments passed to most method calls. If it finds any problems,
1826	it will croak.	1864	it will croak.
1827		1865
1828	In other words, enables "strict" mode.	1866	In other words, enables "strict" mode.
1829		1867
1830	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	1868	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1831	>>, it is definitely recommended to keep it off in production. Keeping	1869	>>, it is definitely recommended to keep it off in production. Keeping
1832	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1870	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1833	can be very useful, however.	1871	can be very useful, however.
1834		1872
1835	=item C<PERL_ANYEVENT_MODEL>	1873	=item C<PERL_ANYEVENT_MODEL>
…		…
2057		2095
2058	The actual code goes further and collects all errors (C<die>s, exceptions)	2096	The actual code goes further and collects all errors (C<die>s, exceptions)
2059	that occurred during request processing. The C<result> method detects	2097	that occurred during request processing. The C<result> method detects
2060	whether an exception as thrown (it is stored inside the $txn object)	2098	whether an exception as thrown (it is stored inside the $txn object)
2061	and just throws the exception, which means connection errors and other	2099	and just throws the exception, which means connection errors and other
2062	problems get reported tot he code that tries to use the result, not in a	2100	problems get reported to the code that tries to use the result, not in a
2063	random callback.	2101	random callback.
2064		2102
2065	All of this enables the following usage styles:	2103	All of this enables the following usage styles:
2066		2104
2067	1. Blocking:	2105	1. Blocking:
…		…
2481	unless defined $SIG{PIPE};	2519	unless defined $SIG{PIPE};
2482		2520
2483	=head1 RECOMMENDED/OPTIONAL MODULES	2521	=head1 RECOMMENDED/OPTIONAL MODULES
2484		2522
2485	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2523	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2486	it's built-in modules) are required to use it.	2524	its built-in modules) are required to use it.
2487		2525
2488	That does not mean that AnyEvent won't take advantage of some additional	2526	That does not mean that AnyEvent won't take advantage of some additional
2489	modules if they are installed.	2527	modules if they are installed.
2490		2528
2491	This section explains which additional modules will be used, and how they	2529	This section explains which additional modules will be used, and how they
…		…
2524	automatic timer adjustments even when no monotonic clock is available,	2562	automatic timer adjustments even when no monotonic clock is available,
2525	can take avdantage of advanced kernel interfaces such as C<epoll> and	2563	can take avdantage of advanced kernel interfaces such as C<epoll> and
2526	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2564	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2527	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2565	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2528		2566
		2567	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2568	then this module will do nothing for you.
		2569
2529	=item L<Guard>	2570	=item L<Guard>
2530		2571
2531	The guard module, when used, will be used to implement	2572	The guard module, when used, will be used to implement
2532	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2573	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2533	lot less memory), but otherwise doesn't affect guard operation much. It is	2574	lot less memory), but otherwise doesn't affect guard operation much. It is
2534	purely used for performance.	2575	purely used for performance.
2535		2576
2536	=item L<JSON> and L<JSON::XS>	2577	=item L<JSON> and L<JSON::XS>
2537		2578
2538	One of these modules is required when you want to read or write JSON data	2579	One of these modules is required when you want to read or write JSON data
2539	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2580	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2540	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2581	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2541
2542	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2543	installed.
2544		2582
2545	=item L<Net::SSLeay>	2583	=item L<Net::SSLeay>
2546		2584
2547	Implementing TLS/SSL in Perl is certainly interesting, but not very	2585	Implementing TLS/SSL in Perl is certainly interesting, but not very
2548	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2586	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2549	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2587	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2550		2588
2551	=item L<Time::HiRes>	2589	=item L<Time::HiRes>
2552		2590
2553	This module is part of perl since release 5.008. It will be used when the	2591	This module is part of perl since release 5.008. It will be used when the
2554	chosen event library does not come with a timing source on it's own. The	2592	chosen event library does not come with a timing source of its own. The
2555	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2593	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2556	try to use a monotonic clock for timing stability.	2594	try to use a monotonic clock for timing stability.
2557		2595
2558	=back	2596	=back
2559		2597
…		…
2622	pronounced).	2660	pronounced).
2623		2661
2624		2662
2625	=head1 SEE ALSO	2663	=head1 SEE ALSO
2626		2664
		2665	Tutorial/Introduction: L<AnyEvent::Intro>.
		2666
		2667	FAQ: L<AnyEvent::FAQ>.
		2668
2627	Utility functions: L<AnyEvent::Util>.	2669	Utility functions: L<AnyEvent::Util>.
2628		2670
2629	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2671	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
2630	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2672	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2631		2673
…		…
2637	Non-blocking file handles, sockets, TCP clients and	2679	Non-blocking file handles, sockets, TCP clients and
2638	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2680	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2639		2681
2640	Asynchronous DNS: L<AnyEvent::DNS>.	2682	Asynchronous DNS: L<AnyEvent::DNS>.
2641		2683
2642	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2684	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2643	L<Coro::Event>,
2644		2685
2645	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2686	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2646	L<AnyEvent::HTTP>.	2687	L<AnyEvent::HTTP>.
2647		2688
2648		2689
2649	=head1 AUTHOR	2690	=head1 AUTHOR
2650		2691

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.315 by root, Sat Mar 13 00:08:08 2010 UTC vs. Revision 1.338 by root, Tue Nov 23 04:45:59 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.315 by root, Sat Mar 13 00:08:08 2010 UTC vs.
Revision 1.338 by root, Tue Nov 23 04:45:59 2010 UTC