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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.316 by root, Mon Mar 15 18:51:30 2010 UTC vs.
Revision 1.333 by root, Tue Oct 12 06:47:54 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
…		…
73	module users into the same thing by forcing them to use the same event	76	module users into the same thing by forcing them to use the same event
74	model you use.	77	model you use.
75		78
76	For modules like POE or IO::Async (which is a total misnomer as it is	79	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	80	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	81	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	82	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	83	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.	84	module are I<also> forced to use the same event loop you use.
82		85
83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	86	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	87	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	88	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,	89	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	90	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	91	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	92	use one of the supported event loops. It is easy to add new event loops
90	to AnyEvent, too, so it is future-proof).	93	to AnyEvent, too, so it is future-proof).
91		94
92	In addition to being free of having to use I<the one and only true event	95	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	96	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	97	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	98	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	99	offering the functionality that is necessary, in as thin as a wrapper as
97	technically possible.	100	technically possible.
98		101
99	Of course, AnyEvent comes with a big (and fully optional!) toolbox	102	Of course, AnyEvent comes with a big (and fully optional!) toolbox
100	of useful functionality, such as an asynchronous DNS resolver, 100%	103	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	109	useful) and you want to force your users to use the one and only event
107	model, you should I<not> use this module.	110	model, you should I<not> use this module.
108		111
109	=head1 DESCRIPTION	112	=head1 DESCRIPTION
110		113
111	L<AnyEvent> provides an identical interface to multiple event loops. This	114	L<AnyEvent> provides a uniform interface to various event loops. This
112	allows module authors to utilise an event loop without forcing module	115	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	116	module users to use a specific event loop implementation (since more
114	peacefully at any one time).	117	than one event loop cannot coexist peacefully).
115		118
116	The interface itself is vaguely similar, but not identical to the L<Event>	119	The interface itself is vaguely similar, but not identical to the L<Event>
117	module.	120	module.
118		121
119	During the first call of any watcher-creation method, the module tries	122	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	123	to detect the currently loaded event loop by probing whether one of the
121	following modules is already loaded: L<EV>,	124	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>,	125	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	126	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	127	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	128	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	129	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		130
130	Because AnyEvent first checks for modules that are already loaded, loading	131	Because AnyEvent first checks for modules that are already loaded, loading
131	an event model explicitly before first using AnyEvent will likely make	132	an event model explicitly before first using AnyEvent will likely make
132	that model the default. For example:	133	that model the default. For example:
133		134
…		…
135	use AnyEvent;	136	use AnyEvent;
136		137
137	# .. AnyEvent will likely default to Tk	138	# .. AnyEvent will likely default to Tk
138		139
139	The I<likely> means that, if any module loads another event model and	140	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	141	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...	142	as very few modules hardcode event loops without announcing this very
		143	loudly.
142		144
143	The pure-perl implementation of AnyEvent is called	145	The pure-perl implementation of AnyEvent is called
144	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	146	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
145	explicitly and enjoy the high availability of that event loop :)	147	explicitly and enjoy the high availability of that event loop :)
146		148
…		…
155	callback when the event occurs (of course, only when the event model	157	callback when the event occurs (of course, only when the event model
156	is in control).	158	is in control).
157		159
158	Note that B<callbacks must not permanently change global variables>	160	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<<	161	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	162	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	163	Perl and the latter stems from the fact that exception handling differs
162	widely between event loops.	164	widely between event loops.
163		165
164	To disable the watcher you have to destroy it (e.g. by setting the	166	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	167	variable you store it in to C<undef> or otherwise deleting all references
166	to it).	168	to it).
167		169
168	All watchers are created by calling a method on the C<AnyEvent> class.	170	All watchers are created by calling a method on the C<AnyEvent> class.
169		171
170	Many watchers either are used with "recursion" (repeating timers for	172	Many watchers either are used with "recursion" (repeating timers for
171	example), or need to refer to their watcher object in other ways.	173	example), or need to refer to their watcher object in other ways.
172		174
173	An any way to achieve that is this pattern:	175	One way to achieve that is this pattern:
174		176
175	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	177	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
176	# you can use $w here, for example to undef it	178	# you can use $w here, for example to undef it
177	undef $w;	179	undef $w;
178	});	180	});
…		…
210		212
211	The I/O watcher might use the underlying file descriptor or a copy of it.	213	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	214	You must not close a file handle as long as any watcher is active on the
213	underlying file descriptor.	215	underlying file descriptor.
214		216
215	Some event loops issue spurious readyness notifications, so you should	217	Some event loops issue spurious readiness notifications, so you should
216	always use non-blocking calls when reading/writing from/to your file	218	always use non-blocking calls when reading/writing from/to your file
217	handles.	219	handles.
218		220
219	Example: wait for readability of STDIN, then read a line and disable the	221	Example: wait for readability of STDIN, then read a line and disable the
220	watcher.	222	watcher.
…		…
244		246
245	Although the callback might get passed parameters, their value and	247	Although the callback might get passed parameters, their value and
246	presence is undefined and you cannot rely on them. Portable AnyEvent	248	presence is undefined and you cannot rely on them. Portable AnyEvent
247	callbacks cannot use arguments passed to time watcher callbacks.	249	callbacks cannot use arguments passed to time watcher callbacks.
248		250
249	The callback will normally be invoked once only. If you specify another	251	The callback will normally be invoked only once. If you specify another
250	parameter, C<interval>, as a strictly positive number (> 0), then the	252	parameter, C<interval>, as a strictly positive number (> 0), then the
251	callback will be invoked regularly at that interval (in fractional	253	callback will be invoked regularly at that interval (in fractional
252	seconds) after the first invocation. If C<interval> is specified with a	254	seconds) after the first invocation. If C<interval> is specified with a
253	false value, then it is treated as if it were missing.	255	false value, then it is treated as if it were not specified at all.
254		256
255	The callback will be rescheduled before invoking the callback, but no	257	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	258	attempt is made to avoid timer drift in most backends, so the interval is
257	only approximate.	259	only approximate.
258		260
259	Example: fire an event after 7.7 seconds.	261	Example: fire an event after 7.7 seconds.
260		262
261	my $w = AnyEvent->timer (after => 7.7, cb => sub {	263	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
279		281
280	While most event loops expect timers to specified in a relative way, they	282	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	283	use absolute time internally. This makes a difference when your clock
282	"jumps", for example, when ntp decides to set your clock backwards from	284	"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	285	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.	286	fire "after a second" might actually take six years to finally fire.
285		287
286	AnyEvent cannot compensate for this. The only event loop that is conscious	288	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	289	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)	290	on true relative time) and absolute (ev_periodic, based on wallclock time)
289	timers.	291	timers.
290		292
291	AnyEvent always prefers relative timers, if available, matching the	293	AnyEvent always prefers relative timers, if available, matching the
292	AnyEvent API.	294	AnyEvent API.
…		…
314	I<In almost all cases (in all cases if you don't care), this is the	316	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.>	317	function to call when you want to know the current time.>
316		318
317	This function is also often faster then C<< AnyEvent->time >>, and	319	This function is also often faster then C<< AnyEvent->time >>, and
318	thus the preferred method if you want some timestamp (for example,	320	thus the preferred method if you want some timestamp (for example,
319	L<AnyEvent::Handle> uses this to update it's activity timeouts).	321	L<AnyEvent::Handle> uses this to update its activity timeouts).
320		322
321	The rest of this section is only of relevance if you try to be very exact	323	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.	324	with your timing; you can skip it without a bad conscience.
323		325
324	For a practical example of when these times differ, consider L<Event::Lib>	326	For a practical example of when these times differ, consider L<Event::Lib>
325	and L<EV> and the following set-up:	327	and L<EV> and the following set-up:
326		328
327	The event loop is running and has just invoked one of your callback at	329	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,	330	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	331	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	332	second) and then (at time=501) you create a relative timer that fires
331	after three seconds.	333	after three seconds.
332		334
…		…
425	=head3 Signal Races, Delays and Workarounds	427	=head3 Signal Races, Delays and Workarounds
426		428
427	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	429	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	430	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	431	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,	432	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	433	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	434	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
433	variable can be changed only before the first signal watcher is created,	435	variable can be changed only before the first signal watcher is created,
434	and should be left alone otherwise. This variable determines how often	436	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	437	AnyEvent polls for signals (in case a wake-up was missed). Higher values
…		…
437	saving.	439	saving.
438		440
439	All these problems can be avoided by installing the optional	441	All these problems can be avoided by installing the optional
440	L<Async::Interrupt> module, which works with most event loops. It will not	442	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>	443	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	444	(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.	445	one-second latency). For those, you just have to suffer the delays.
444		446
445	=head2 CHILD PROCESS WATCHERS	447	=head2 CHILD PROCESS WATCHERS
446		448
447	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	449	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
448		450
449	You can also watch on a child process exit and catch its exit status.	451	You can also watch for a child process exit and catch its exit status.
450		452
451	The child process is specified by the C<pid> argument (one some backends,	453	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	454	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	455	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	456	finished and an exit status is available, not on any trace events
455	(stopped/continued).	457	(stopped/continued).
456		458
…		…
503		505
504	=head2 IDLE WATCHERS	506	=head2 IDLE WATCHERS
505		507
506	$w = AnyEvent->idle (cb => <callback>);	508	$w = AnyEvent->idle (cb => <callback>);
507		509
508	Repeatedly invoke the callback after the process becomes idle, until	510	This will repeatedly invoke the callback after the process becomes idle,
509	either the watcher is destroyed or new events have been detected.	511	until either the watcher is destroyed or new events have been detected.
510		512
511	Idle watchers are useful when there is a need to do something, but it	513	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	514	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	515	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	516	defined as "all outstanding events have been handled and no new events
…		…
553	will actively watch for new events and call your callbacks.	555	will actively watch for new events and call your callbacks.
554		556
555	AnyEvent is slightly different: it expects somebody else to run the event	557	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).	558	loop and will only block when necessary (usually when told by the user).
557		559
558	The instrument to do that is called a "condition variable", so called	560	The tool to do that is called a "condition variable", so called because
559	because they represent a condition that must become true.	561	they represent a condition that must become true.
560		562
561	Now is probably a good time to look at the examples further below.	563	Now is probably a good time to look at the examples further below.
562		564
563	Condition variables can be created by calling the C<< AnyEvent->condvar	565	Condition variables can be created by calling the C<< AnyEvent->condvar
564	>> method, usually without arguments. The only argument pair allowed is	566	>> method, usually without arguments. The only argument pair allowed is
…		…
569	After creation, the condition variable is "false" until it becomes "true"	571	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	572	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<<	573	were a callback, read about the caveats in the description for the C<<
572	->send >> method).	574	->send >> method).
573		575
574	Condition variables are similar to callbacks, except that you can	576	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	577	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	578
577	another way to call them is transactions - each condition variable can be	579	=over 4
578	used to represent a transaction, which finishes at some point and delivers	580
579	a result. And yet some people know them as "futures" - a promise to	581	=item * Condition variables are like callbacks - you can call them (and pass them instead
580	compute/deliver something that you can wait for.	582	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		583
		584	=item * Condition variables are signals - one side can emit or send them,
		585	the other side can wait for them, or install a handler that is called when
		586	the signal fires.
		587
		588	=item * Condition variables are like "Merge Points" - points in your program
		589	where you merge multiple independent results/control flows into one.
		590
		591	=item * Condition variables represent a transaction - functions that start
		592	some kind of transaction can return them, leaving the caller the choice
		593	between waiting in a blocking fashion, or setting a callback.
		594
		595	=item * Condition variables represent future values, or promises to deliver
		596	some result, long before the result is available.
		597
		598	=back
581		599
582	Condition variables are very useful to signal that something has finished,	600	Condition variables are very useful to signal that something has finished,
583	for example, if you write a module that does asynchronous http requests,	601	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	602	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	603	availability of results. The user can either act when the callback is
…		…
598		616
599	Condition variables are represented by hash refs in perl, and the keys	617	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	618	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	619	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	620	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
603	it's C<new> method in your own C<new> method.	621	its C<new> method in your own C<new> method.
604		622
605	There are two "sides" to a condition variable - the "producer side" which	623	There are two "sides" to a condition variable - the "producer side" which
606	eventually calls C<< -> send >>, and the "consumer side", which waits	624	eventually calls C<< -> send >>, and the "consumer side", which waits
607	for the send to occur.	625	for the send to occur.
608		626
609	Example: wait for a timer.	627	Example: wait for a timer.
610		628
611	# wait till the result is ready	629	# condition: "wait till the timer is fired"
612	my $result_ready = AnyEvent->condvar;	630	my $timer_fired = AnyEvent->condvar;
613		631
614	# do something such as adding a timer	632	# create the timer - we could wait for, say
615	# or socket watcher the calls $result_ready->send	633	# a handle becomign ready, or even an
616	# when the "result" is ready.	634	# AnyEvent::HTTP request to finish, but
617	# in this case, we simply use a timer:	635	# in this case, we simply use a timer:
618	my $w = AnyEvent->timer (	636	my $w = AnyEvent->timer (
619	after => 1,	637	after => 1,
620	cb => sub { $result_ready->send },	638	cb => sub { $timer_fired->send },
621	);	639	);
622		640
623	# this "blocks" (while handling events) till the callback	641	# this "blocks" (while handling events) till the callback
624	# calls ->send	642	# calls ->send
625	$result_ready->recv;	643	$timer_fired->recv;
626		644
627	Example: wait for a timer, but take advantage of the fact that condition	645	Example: wait for a timer, but take advantage of the fact that condition
628	variables are also callable directly.	646	variables are also callable directly.
629		647
630	my $done = AnyEvent->condvar;	648	my $done = AnyEvent->condvar;
…		…
673	they were a code reference). Calling them directly is the same as calling	691	they were a code reference). Calling them directly is the same as calling
674	C<send>.	692	C<send>.
675		693
676	=item $cv->croak ($error)	694	=item $cv->croak ($error)
677		695
678	Similar to send, but causes all call's to C<< ->recv >> to invoke	696	Similar to send, but causes all calls to C<< ->recv >> to invoke
679	C<Carp::croak> with the given error message/object/scalar.	697	C<Carp::croak> with the given error message/object/scalar.
680		698
681	This can be used to signal any errors to the condition variable	699	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	700	user/consumer. Doing it this way instead of calling C<croak> directly
683	delays the error detetcion, but has the overwhelmign advantage that it	701	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	702	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	703	deep in some event callback with no connection to the actual code causing
686	the problem.	704	the problem.
687		705
688	=item $cv->begin ([group callback])	706	=item $cv->begin ([group callback])
689		707
690	=item $cv->end	708	=item $cv->end
…		…
728	one call to C<begin>, so the condvar waits for all calls to C<end> before	746	one call to C<begin>, so the condvar waits for all calls to C<end> before
729	sending.	747	sending.
730		748
731	The ping example mentioned above is slightly more complicated, as the	749	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	750	there are results to be passwd back, and the number of tasks that are
733	begung can potentially be zero:	751	begun can potentially be zero:
734		752
735	my $cv = AnyEvent->condvar;	753	my $cv = AnyEvent->condvar;
736		754
737	my %result;	755	my %result;
738	$cv->begin (sub { shift->send (\%result) });	756	$cv->begin (sub { shift->send (\%result) });
…		…
759	to be called once the counter reaches C<0>, and second, it ensures that	777	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	778	C<send> is called even when C<no> hosts are being pinged (the loop
761	doesn't execute once).	779	doesn't execute once).
762		780
763	This is the general pattern when you "fan out" into multiple (but	781	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	782	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	783	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,	784	subrequest you start, call C<begin> and for each subrequest you finish,
767	call C<end>.	785	call C<end>.
768		786
769	=back	787	=back
…		…
776	=over 4	794	=over 4
777		795
778	=item $cv->recv	796	=item $cv->recv
779		797
780	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	798	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
781	>> methods have been called on c<$cv>, while servicing other watchers	799	>> methods have been called on C<$cv>, while servicing other watchers
782	normally.	800	normally.
783		801
784	You can only wait once on a condition - additional calls are valid but	802	You can only wait once on a condition - additional calls are valid but
785	will return immediately.	803	will return immediately.
786		804
…		…
803	caller decide whether the call will block or not (for example, by coupling	821	caller decide whether the call will block or not (for example, by coupling
804	condition variables with some kind of request results and supporting	822	condition variables with some kind of request results and supporting
805	callbacks so the caller knows that getting the result will not block,	823	callbacks so the caller knows that getting the result will not block,
806	while still supporting blocking waits if the caller so desires).	824	while still supporting blocking waits if the caller so desires).
807		825
808	You can ensure that C<< -recv >> never blocks by setting a callback and	826	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	827	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	828	time). This will work even when the event loop does not support blocking
811	waits otherwise.	829	waits otherwise.
812		830
813	=item $bool = $cv->ready	831	=item $bool = $cv->ready
…		…
818	=item $cb = $cv->cb ($cb->($cv))	836	=item $cb = $cv->cb ($cb->($cv))
819		837
820	This is a mutator function that returns the callback set and optionally	838	This is a mutator function that returns the callback set and optionally
821	replaces it before doing so.	839	replaces it before doing so.
822		840
823	The callback will be called when the condition becomes (or already was)	841	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	842	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>	843	condition variable itself. If the condition is already true, the
		844	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.	845	the callback or at any later time is guaranteed not to block.
827		846
828	=back	847	=back
829		848
830	=head1 SUPPORTED EVENT LOOPS/BACKENDS	849	=head1 SUPPORTED EVENT LOOPS/BACKENDS
831		850
…		…
843	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
844	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	863	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
845		864
846	=item Backends that are transparently being picked up when they are used.	865	=item Backends that are transparently being picked up when they are used.
847		866
848	These will be used when they are currently loaded when the first watcher	867	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	868	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	869	them. This means that AnyEvent will automatically pick the right backend
851	when the main program loads an event module before anything starts to	870	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.	871	create watchers. Nothing special needs to be done by the main program.
853		872
…		…
869		888
870	Support for IO::Async can only be partial, as it is too broken and	889	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	890	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	891	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	892	it can only be used by a main program knowing about AnyEvent. See
874	L<AnyEvent::Impl::Async> for the gory details.	893	L<AnyEvent::Impl::IOAsync> for the gory details.
875		894
876	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.	895	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
877		896
878	=item Event loops that are indirectly supported via other backends.	897	=item Event loops that are indirectly supported via other backends.
879		898
…		…
907	Contains C<undef> until the first watcher is being created, before the	926	Contains C<undef> until the first watcher is being created, before the
908	backend has been autodetected.	927	backend has been autodetected.
909		928
910	Afterwards it contains the event model that is being used, which is the	929	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	930	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	931	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	932	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
914	will be C<urxvt::anyevent>).	933	will be C<urxvt::anyevent>).
915		934
916	=item AnyEvent::detect	935	=item AnyEvent::detect
917		936
918	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	937	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
919	if necessary. You should only call this function right before you would	938	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	939	have created an AnyEvent watcher anyway, that is, as late as possible at
921	runtime, and not e.g. while initialising of your module.	940	runtime, and not e.g. during initialisation of your module.
922		941
923	If you need to do some initialisation before AnyEvent watchers are	942	If you need to do some initialisation before AnyEvent watchers are
924	created, use C<post_detect>.	943	created, use C<post_detect>.
925		944
926	=item $guard = AnyEvent::post_detect { BLOCK }	945	=item $guard = AnyEvent::post_detect { BLOCK }
927		946
928	Arranges for the code block to be executed as soon as the event model is	947	Arranges for the code block to be executed as soon as the event model is
929	autodetected (or immediately if this has already happened).	948	autodetected (or immediately if that has already happened).
930		949
931	The block will be executed I<after> the actual backend has been detected	950	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	951	(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	952	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	953	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
943	that automatically removes the callback again when it is destroyed (or	962	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	963	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
945	a case where this is useful.	964	a case where this is useful.
946		965
947	Example: Create a watcher for the IO::AIO module and store it in	966	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.	967	C<$WATCHER>, but do so only do so after the event loop is initialised.
949		968
950	our WATCHER;	969	our WATCHER;
951		970
952	my $guard = AnyEvent::post_detect {	971	my $guard = AnyEvent::post_detect {
953	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	972	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
961	$WATCHER \|\|= $guard;	980	$WATCHER \|\|= $guard;
962		981
963	=item @AnyEvent::post_detect	982	=item @AnyEvent::post_detect
964		983
965	If there are any code references in this array (you can C<push> to it	984	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	985	before or after loading AnyEvent), then they will be called directly
967	the event loop has been chosen.	986	after the event loop has been chosen.
968		987
969	You should check C<$AnyEvent::MODEL> before adding to this array, though:	988	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	989	if it is defined then the event loop has already been detected, and the
971	array will be ignored.	990	array will be ignored.
972		991
…		…
1008	because it will stall the whole program, and the whole point of using	1027	because it will stall the whole program, and the whole point of using
1009	events is to stay interactive.	1028	events is to stay interactive.
1010		1029
1011	It is fine, however, to call C<< ->recv >> when the user of your module	1030	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	1031	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 >>	1032	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).	1033	freely, as the user of your module knows what she is doing. Always).
1015		1034
1016	=head1 WHAT TO DO IN THE MAIN PROGRAM	1035	=head1 WHAT TO DO IN THE MAIN PROGRAM
1017		1036
1018	There will always be a single main program - the only place that should	1037	There will always be a single main program - the only place that should
1019	dictate which event model to use.	1038	dictate which event model to use.
1020		1039
1021	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1040	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	1041	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.	1042	uses AnyEvent, but does not care which event loop is used, all it needs
		1043	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1044	available loop implementation.
1024		1045
1025	If the main program relies on a specific event model - for example, in	1046	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	1047	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	1048	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	1049	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	1050	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	1051	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.	1052	might choose the wrong one unless you load the correct one yourself.
1032		1053
1033	You can chose to use a pure-perl implementation by loading the	1054	You can chose to use a pure-perl implementation by loading the
1034	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1055	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
1035	everywhere, but letting AnyEvent chose the model is generally better.	1056	everywhere, but letting AnyEvent chose the model is generally better.
1036		1057
…		…
1054	=head1 OTHER MODULES	1075	=head1 OTHER MODULES
1055		1076
1056	The following is a non-exhaustive list of additional modules that use	1077	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	1078	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	1079	modules and other event loops in the same program. Some of the modules
1059	come with AnyEvent, most are available via CPAN.	1080	come as part of AnyEvent, the others are available via CPAN.
1060		1081
1061	=over 4	1082	=over 4
1062		1083
1063	=item L<AnyEvent::Util>	1084	=item L<AnyEvent::Util>
1064		1085
1065	Contains various utility functions that replace often-used but blocking	1086	Contains various utility functions that replace often-used blocking
1066	functions such as C<inet_aton> by event-/callback-based versions.	1087	functions such as C<inet_aton> with event/callback-based versions.
1067		1088
1068	=item L<AnyEvent::Socket>	1089	=item L<AnyEvent::Socket>
1069		1090
1070	Provides various utility functions for (internet protocol) sockets,	1091	Provides various utility functions for (internet protocol) sockets,
1071	addresses and name resolution. Also functions to create non-blocking tcp	1092	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1073		1094
1074	=item L<AnyEvent::Handle>	1095	=item L<AnyEvent::Handle>
1075		1096
1076	Provide read and write buffers, manages watchers for reads and writes,	1097	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	1098	supports raw and formatted I/O, I/O queued and fully transparent and
1078	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1099	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1079		1100
1080	=item L<AnyEvent::DNS>	1101	=item L<AnyEvent::DNS>
1081		1102
1082	Provides rich asynchronous DNS resolver capabilities.	1103	Provides rich asynchronous DNS resolver capabilities.
1083		1104
		1105	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1106
		1107	Implement event-based interfaces to the protocols of the same name (for
		1108	the curious, IGS is the International Go Server and FCP is the Freenet
		1109	Client Protocol).
		1110
		1111	=item L<AnyEvent::Handle::UDP>
		1112
		1113	Here be danger!
		1114
		1115	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1116	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1117	its use of a stream-based API with a protocol that isn't streamable, that
		1118	the only way to improve it is to delete it.
		1119
		1120	It features data corruption (but typically only under load) and general
		1121	confusion. On top, the author is not only clueless about UDP but also
		1122	fact-resistant - some gems of his understanding: "connect doesn't work
		1123	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1124	packets", "I don't need to implement proper error checking as UDP doesn't
		1125	support error checking" and so on - he doesn't even understand what's
		1126	wrong with his module when it is explained to him.
		1127
1084	=item L<AnyEvent::HTTP>	1128	=item L<AnyEvent::DBI>
1085		1129
1086	A simple-to-use HTTP library that is capable of making a lot of concurrent	1130	Executes L<DBI> requests asynchronously in a proxy process for you,
1087	HTTP requests.	1131	notifying you in an event-based way when the operation is finished.
		1132
		1133	=item L<AnyEvent::AIO>
		1134
		1135	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1136	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1137	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1138	file I/O, and much more.
1088		1139
1089	=item L<AnyEvent::HTTPD>	1140	=item L<AnyEvent::HTTPD>
1090		1141
1091	Provides a simple web application server framework.	1142	A simple embedded webserver.
1092		1143
1093	=item L<AnyEvent::FastPing>	1144	=item L<AnyEvent::FastPing>
1094		1145
1095	The fastest ping in the west.	1146	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		1147
1139	=item L<Coro>	1148	=item L<Coro>
1140		1149
1141	Has special support for AnyEvent via L<Coro::AnyEvent>.	1150	Has special support for AnyEvent via L<Coro::AnyEvent>.
1142		1151
…		…
1146		1155
1147	package AnyEvent;	1156	package AnyEvent;
1148		1157
1149	# basically a tuned-down version of common::sense	1158	# basically a tuned-down version of common::sense
1150	sub common_sense {	1159	sub common_sense {
1151	# from common:.sense 1.0	1160	# from common:.sense 3.3
1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1161	${^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)	1162	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1154	$^H \|= 0x00000600;	1163	$^H \|= 0x00000600;
1155	}	1164	}
1156		1165
1157	BEGIN { AnyEvent::common_sense }	1166	BEGIN { AnyEvent::common_sense }
1158		1167
1159	use Carp ();	1168	use Carp ();
1160		1169
1161	our $VERSION = '5.251';	1170	our $VERSION = '5.271';
1162	our $MODEL;	1171	our $MODEL;
1163		1172
1164	our $AUTOLOAD;	1173	our $AUTOLOAD;
1165	our @ISA;	1174	our @ISA;
1166		1175
…		…
1169	our $VERBOSE;	1178	our $VERBOSE;
1170		1179
1171	BEGIN {	1180	BEGIN {
1172	require "AnyEvent/constants.pl";	1181	require "AnyEvent/constants.pl";
1173		1182
1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";	1183	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1175		1184
1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1185	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1177	if ${^TAINT};	1186	if ${^TAINT};
1178		1187
1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1188	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1222	our @post_detect;	1231	our @post_detect;
1223		1232
1224	sub post_detect(&) {	1233	sub post_detect(&) {
1225	my ($cb) = @_;	1234	my ($cb) = @_;
1226		1235
1227	if ($MODEL) {
1228	$cb->();
1229
1230	undef
1231	} else {
1232	push @post_detect, $cb;	1236	push @post_detect, $cb;
1233		1237
1234	defined wantarray	1238	defined wantarray
1235	? bless \$cb, "AnyEvent::Util::postdetect"	1239	? bless \$cb, "AnyEvent::Util::postdetect"
1236	: ()	1240	: ()
1237	}
1238	}	1241	}
1239		1242
1240	sub AnyEvent::Util::postdetect::DESTROY {	1243	sub AnyEvent::Util::postdetect::DESTROY {
1241	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1244	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1242	}	1245	}
…		…
1295	@models = (); # free probe data	1298	@models = (); # free probe data
1296		1299
1297	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1300	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1298	unshift @ISA, $MODEL;	1301	unshift @ISA, $MODEL;
1299		1302
		1303	# now nuke some methods that are overriden by the backend.
		1304	# SUPER is not allowed.
		1305	for (qw(time signal child idle)) {
		1306	undef &{"AnyEvent::Base::$_"}
		1307	if defined &{"$MODEL\::$_"};
		1308	}
		1309
1300	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1310	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1301		1311
1302	(shift @post_detect)->() while @post_detect;	1312	(shift @post_detect)->() while @post_detect;
		1313
		1314	*post_detect = sub(&) {
		1315	shift->();
		1316
		1317	undef
		1318	};
1303		1319
1304	$MODEL	1320	$MODEL
1305	}	1321	}
1306		1322
1307	sub AUTOLOAD {	1323	sub AUTOLOAD {
…		…
1335		1351
1336	=head1 SIMPLIFIED AE API	1352	=head1 SIMPLIFIED AE API
1337		1353
1338	Starting with version 5.0, AnyEvent officially supports a second, much	1354	Starting with version 5.0, AnyEvent officially supports a second, much
1339	simpler, API that is designed to reduce the calling, typing and memory	1355	simpler, API that is designed to reduce the calling, typing and memory
1340	overhead.	1356	overhead by using function call syntax and a fixed number of parameters.
1341		1357
1342	See the L<AE> manpage for details.	1358	See the L<AE> manpage for details.
1343		1359
1344	=cut	1360	=cut
1345		1361
1346	package AE;	1362	package AE;
1347		1363
1348	our $VERSION = $AnyEvent::VERSION;	1364	our $VERSION = $AnyEvent::VERSION;
		1365
		1366	# fall back to the main API by default - backends and AnyEvent::Base
		1367	# implementations can overwrite these.
1349		1368
1350	sub io($$$) {	1369	sub io($$$) {
1351	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1370	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1352	}	1371	}
1353		1372
…		…
1385		1404
1386	package AnyEvent::Base;	1405	package AnyEvent::Base;
1387		1406
1388	# default implementations for many methods	1407	# default implementations for many methods
1389		1408
1390	sub _time() {	1409	sub time {
1391	eval q{ # poor man's autoloading	1410	eval q{ # poor man's autoloading {}
1392	# probe for availability of Time::HiRes	1411	# probe for availability of Time::HiRes
1393	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1412	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1394	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1413	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1395	*_time = \&Time::HiRes::time;	1414	*AE::time = \&Time::HiRes::time;
1396	# if (eval "use POSIX (); (POSIX::times())...	1415	# if (eval "use POSIX (); (POSIX::times())...
1397	} else {	1416	} else {
1398	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1417	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1399	*_time = sub (){ time }; # epic fail	1418	*AE::time = sub (){ time }; # epic fail
1400	}	1419	}
		1420
		1421	*time = sub { AE::time }; # different prototypes
1401	};	1422	};
1402	die if $@;	1423	die if $@;
1403		1424
1404	&_time	1425	&time
1405	}	1426	}
1406		1427
1407	sub time { _time }	1428	*now = \&time;
1408	sub now { _time }	1429
1409	sub now_update { }	1430	sub now_update { }
1410		1431
1411	# default implementation for ->condvar	1432	# default implementation for ->condvar
1412		1433
1413	sub condvar {	1434	sub condvar {
		1435	eval q{ # poor man's autoloading {}
		1436	*condvar = sub {
1414	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1437	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1438	};
		1439
		1440	*AE::cv = sub (;&) {
		1441	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1442	};
		1443	};
		1444	die if $@;
		1445
		1446	&condvar
1415	}	1447	}
1416		1448
1417	# default implementation for ->signal	1449	# default implementation for ->signal
1418		1450
1419	our $HAVE_ASYNC_INTERRUPT;	1451	our $HAVE_ASYNC_INTERRUPT;
…		…
1449	undef $SIG_TW	1481	undef $SIG_TW
1450	unless --$SIG_COUNT;	1482	unless --$SIG_COUNT;
1451	}	1483	}
1452		1484
1453	our $_sig_name_init; $_sig_name_init = sub {	1485	our $_sig_name_init; $_sig_name_init = sub {
1454	eval q{ # poor man's autoloading	1486	eval q{ # poor man's autoloading {}
1455	undef $_sig_name_init;	1487	undef $_sig_name_init;
1456		1488
1457	if (_have_async_interrupt) {	1489	if (_have_async_interrupt) {
1458	*sig2num = \&Async::Interrupt::sig2num;	1490	*sig2num = \&Async::Interrupt::sig2num;
1459	*sig2name = \&Async::Interrupt::sig2name;	1491	*sig2name = \&Async::Interrupt::sig2name;
…		…
1513	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1545	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1514		1546
1515	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1547	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1516	}	1548	}
1517		1549
1518	*signal = sub {	1550	*signal = $HAVE_ASYNC_INTERRUPT
		1551	? sub {
1519	my (undef, %arg) = @_;	1552	my (undef, %arg) = @_;
1520		1553
1521	my $signal = uc $arg{signal}
1522	or Carp::croak "required option 'signal' is missing";
1523
1524	if ($HAVE_ASYNC_INTERRUPT) {
1525	# async::interrupt	1554	# async::interrupt
1526
1527	$signal = sig2num $signal;	1555	my $signal = sig2num $arg{signal};
1528	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1556	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1529		1557
1530	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1558	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1531	cb => sub { undef $SIG_EV{$signal} },	1559	cb => sub { undef $SIG_EV{$signal} },
1532	signal => $signal,	1560	signal => $signal,
1533	pipe => [$SIGPIPE_R->filenos],	1561	pipe => [$SIGPIPE_R->filenos],
1534	pipe_autodrain => 0,	1562	pipe_autodrain => 0,
1535	;	1563	;
1536		1564
1537	} else {	1565	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1566	}
		1567	: sub {
		1568	my (undef, %arg) = @_;
		1569
1538	# pure perl	1570	# pure perl
1539
1540	# AE::Util has been loaded in signal
1541	$signal = sig2name $signal;	1571	my $signal = sig2name $arg{signal};
1542	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1572	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1543		1573
1544	$SIG{$signal} \|\|= sub {	1574	$SIG{$signal} \|\|= sub {
1545	local $!;	1575	local $!;
1546	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1576	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1547	undef $SIG_EV{$signal};	1577	undef $SIG_EV{$signal};
1548	};	1578	};
1549		1579
1550	# can't do signal processing without introducing races in pure perl,	1580	# can't do signal processing without introducing races in pure perl,
1551	# so limit the signal latency.	1581	# so limit the signal latency.
1552	_sig_add;	1582	_sig_add;
1553	}
1554		1583
1555	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1584	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1585	}
1556	};	1586	;
1557		1587
1558	*AnyEvent::Base::signal::DESTROY = sub {	1588	*AnyEvent::Base::signal::DESTROY = sub {
1559	my ($signal, $cb) = @{$_[0]};	1589	my ($signal, $cb) = @{$_[0]};
1560		1590
1561	_sig_del;	1591	_sig_del;
…		…
1695		1725
1696	package AnyEvent::CondVar;	1726	package AnyEvent::CondVar;
1697		1727
1698	our @ISA = AnyEvent::CondVar::Base::;	1728	our @ISA = AnyEvent::CondVar::Base::;
1699		1729
		1730	# only to be used for subclassing
		1731	sub new {
		1732	my $class = shift;
		1733	bless AnyEvent->condvar (@_), $class
		1734	}
		1735
1700	package AnyEvent::CondVar::Base;	1736	package AnyEvent::CondVar::Base;
1701		1737
1702	#use overload	1738	#use overload
1703	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1739	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1704	# fallback => 1;	1740	# fallback => 1;
…		…
1825	check the arguments passed to most method calls. If it finds any problems,	1861	check the arguments passed to most method calls. If it finds any problems,
1826	it will croak.	1862	it will croak.
1827		1863
1828	In other words, enables "strict" mode.	1864	In other words, enables "strict" mode.
1829		1865
1830	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	1866	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	1867	>>, it is definitely recommended to keep it off in production. Keeping
1832	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1868	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1833	can be very useful, however.	1869	can be very useful, however.
1834		1870
1835	=item C<PERL_ANYEVENT_MODEL>	1871	=item C<PERL_ANYEVENT_MODEL>
…		…
2057		2093
2058	The actual code goes further and collects all errors (C<die>s, exceptions)	2094	The actual code goes further and collects all errors (C<die>s, exceptions)
2059	that occurred during request processing. The C<result> method detects	2095	that occurred during request processing. The C<result> method detects
2060	whether an exception as thrown (it is stored inside the $txn object)	2096	whether an exception as thrown (it is stored inside the $txn object)
2061	and just throws the exception, which means connection errors and other	2097	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	2098	problems get reported to the code that tries to use the result, not in a
2063	random callback.	2099	random callback.
2064		2100
2065	All of this enables the following usage styles:	2101	All of this enables the following usage styles:
2066		2102
2067	1. Blocking:	2103	1. Blocking:
…		…
2481	unless defined $SIG{PIPE};	2517	unless defined $SIG{PIPE};
2482		2518
2483	=head1 RECOMMENDED/OPTIONAL MODULES	2519	=head1 RECOMMENDED/OPTIONAL MODULES
2484		2520
2485	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2521	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.	2522	its built-in modules) are required to use it.
2487		2523
2488	That does not mean that AnyEvent won't take advantage of some additional	2524	That does not mean that AnyEvent won't take advantage of some additional
2489	modules if they are installed.	2525	modules if they are installed.
2490		2526
2491	This section explains which additional modules will be used, and how they	2527	This section explains which additional modules will be used, and how they
…		…
2549	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2585	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2550		2586
2551	=item L<Time::HiRes>	2587	=item L<Time::HiRes>
2552		2588
2553	This module is part of perl since release 5.008. It will be used when the	2589	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	2590	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	2591	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2556	try to use a monotonic clock for timing stability.	2592	try to use a monotonic clock for timing stability.
2557		2593
2558	=back	2594	=back
2559		2595

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.316 by root, Mon Mar 15 18:51:30 2010 UTC vs. Revision 1.333 by root, Tue Oct 12 06:47:54 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.316 by root, Mon Mar 15 18:51:30 2010 UTC vs.
Revision 1.333 by root, Tue Oct 12 06:47:54 2010 UTC