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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.329 by root, Sun Jul 11 05:44:22 2010 UTC vs.
Revision 1.365 by root, Tue Aug 16 14:47:26 2011 UTC

…		…
15	# file handle or descriptor readable	15	# file handle or descriptor readable
16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
17		17
18	# one-shot or repeating timers	18	# one-shot or repeating timers
19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
21		21
22	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
24		24
25	# POSIX signal	25	# POSIX signal
…		…
46	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
47	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
48		48
49	=head1 SUPPORT	49	=head1 SUPPORT
50		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
51	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
52	channel, too.	54	channel, too.
53		55
54	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
55	Repository>, at L<http://anyevent.schmorp.de>, for more info.	57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
56		58
…		…
76	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
77	model you use.	79	model you use.
78		80
79	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
80	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
81	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
82	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
83	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
84	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.
85		87
86	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
87	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
88	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
89	your module uses one of those, every user of your module has to use it,	91	uses one of those, every user of your module has to use it, too. But if
90	too. But if your module uses AnyEvent, it works transparently with all	92	your module uses AnyEvent, it works transparently with all event models it
91	event models it supports (including stuff like IO::Async, as long as those	93	supports (including stuff like IO::Async, as long as those use one of the
92	use one of the supported event loops. It is trivial to add new event loops	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
93	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
94		96
95	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
96	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
97	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
98	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
99	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
100	technically possible.	102	technically possible.
101		103
102	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
103	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
109	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
110	model, you should I<not> use this module.	112	model, you should I<not> use this module.
111		113
112	=head1 DESCRIPTION	114	=head1 DESCRIPTION
113		115
114	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
115	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
116	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
117	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
118		120
119	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>
120	module.	122	module.
121		123
122	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
123	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
124	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125	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
126	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
127	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
128	adaptor should always succeed) in the order given. The first one that can	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
129	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
130	found, AnyEvent will fall back to a pure-perl event loop, which is not
131	very efficient, but should work everywhere.
132		132
133	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
134	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
135	that model the default. For example:	135	that model the default. For example:
136		136
…		…
142	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
143	starts using it, all bets are off - this case should be very rare though,	143	starts using it, all bets are off - this case should be very rare though,
144	as very few modules hardcode event loops without announcing this very	144	as very few modules hardcode event loops without announcing this very
145	loudly.	145	loudly.
146		146
147	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	other event modules you can load it explicitly and enjoy the high
149	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
150		150
151	=head1 WATCHERS	151	=head1 WATCHERS
152		152
153	AnyEvent has the central concept of a I<watcher>, which is an object that	153	AnyEvent has the central concept of a I<watcher>, which is an object that
154	stores relevant data for each kind of event you are waiting for, such as	154	stores relevant data for each kind of event you are waiting for, such as
…		…
159	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
160	is in control).	160	is in control).
161		161
162	Note that B<callbacks must not permanently change global variables>	162	Note that B<callbacks must not permanently change global variables>
163	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<<
164	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
165	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
166	widely between event loops.	166	widely between event loops.
167		167
168	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
169	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
170	to it).	170	to it).
171		171
172	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.
173		173
174	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
175	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.
176		176
177	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
178		178
179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
180	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
181	undef $w;	181	undef $w;
182	});	182	});
…		…
214		214
215	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.
216	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
217	underlying file descriptor.	217	underlying file descriptor.
218		218
219	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
220	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
221	handles.	221	handles.
222		222
223	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
224	watcher.	224	watcher.
…		…
248		248
249	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
250	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
251	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
252		252
253	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
254	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
255	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
256	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
257	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.
258		258
259	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
260	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
261	only approximate.	261	only approximate.
262		262
263	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
264		264
265	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
283		283
284	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
285	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
286	"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
287	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
288	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.
289		289
290	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
291	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
292	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)
293	timers.	293	timers.
294		294
295	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
296	AnyEvent API.	296	AnyEvent API.
…		…
318	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
319	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
320		320
321	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
322	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
323	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
324		324
325	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
326	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
327		327
328	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>
329	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
330		330
331	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
332	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
333	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
334	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
335	after three seconds.	335	after three seconds.
336		336
…		…
356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357	account.	357	account.
358		358
359	=item AnyEvent->now_update	359	=item AnyEvent->now_update
360		360
361	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache	361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362	the current time for each loop iteration (see the discussion of L<<	362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363	AnyEvent->now >>, above).	363	above).
364		364
365	When a callback runs for a long time (or when the process sleeps), then	365	When a callback runs for a long time (or when the process sleeps), then
366	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
367	might affect timers and time-outs.	367	might affect timers and time-outs.
368		368
…		…
429	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
430		430
431	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
432	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
433	do race-free signal handling in perl, requiring C libraries for	433	do race-free signal handling in perl, requiring C libraries for
434	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,
435	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
436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
437	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,
438	and should be left alone otherwise. This variable determines how often	438	and should be left alone otherwise. This variable determines how often
439	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
…		…
441	saving.	441	saving.
442		442
443	All these problems can be avoided by installing the optional	443	All these problems can be avoided by installing the optional
444	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
445	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>
446	(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
447	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.
448		448
449	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
450		450
451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
452		452
453	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.
454		454
455	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,
456	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
457	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
458	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
459	(stopped/continued).	459	(stopped/continued).
460		460
…		…
482	thing in an AnyEvent program, you I<have> to create at least one	482	thing in an AnyEvent program, you I<have> to create at least one
483	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
484	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
485		485
486	As most event loops do not support waiting for child events, they will be	486	As most event loops do not support waiting for child events, they will be
487	emulated by AnyEvent in most cases, in which the latency and race problems	487	emulated by AnyEvent in most cases, in which case the latency and race
488	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
489		489
490	Example: fork a process and wait for it	490	Example: fork a process and wait for it
491		491
492	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
493		493
…		…
507		507
508	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
509		509
510	$w = AnyEvent->idle (cb => <callback>);	510	$w = AnyEvent->idle (cb => <callback>);
511		511
512	Repeatedly invoke the callback after the process becomes idle, until	512	This will repeatedly invoke the callback after the process becomes idle,
513	either the watcher is destroyed or new events have been detected.	513	until either the watcher is destroyed or new events have been detected.
514		514
515	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
516	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
517	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
518	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
…		…
588	the signal fires.	588	the signal fires.
589		589
590	=item * Condition variables are like "Merge Points" - points in your program	590	=item * Condition variables are like "Merge Points" - points in your program
591	where you merge multiple independent results/control flows into one.	591	where you merge multiple independent results/control flows into one.
592		592
593	=item * Condition variables represent a transaction - function that start	593	=item * Condition variables represent a transaction - functions that start
594	some kind of transaction can return them, leaving the caller the choice	594	some kind of transaction can return them, leaving the caller the choice
595	between waiting in a blocking fashion, or setting a callback.	595	between waiting in a blocking fashion, or setting a callback.
596		596
597	=item * Condition variables represent future values, or promises to deliver	597	=item * Condition variables represent future values, or promises to deliver
598	some result, long before the result is available.	598	some result, long before the result is available.
…		…
618		618
619	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
620	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
621	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
622	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
623	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
624		624
625	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
626	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
627	for the send to occur.	627	for the send to occur.
628		628
…		…
693	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
694	C<send>.	694	C<send>.
695		695
696	=item $cv->croak ($error)	696	=item $cv->croak ($error)
697		697
698	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
699	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
700		700
701	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
702	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
703	delays the error detetcion, but has the overwhelmign advantage that it	703	delays the error detection, but has the overwhelming advantage that it
704	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
705	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
706	the problem.	706	the problem.
707		707
708	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
709		709
710	=item $cv->end	710	=item $cv->end
…		…
748	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
749	sending.	749	sending.
750		750
751	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
752	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
753	begung can potentially be zero:	753	begun can potentially be zero:
754		754
755	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
756		756
757	my %result;	757	my %result;
758	$cv->begin (sub { shift->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
…		…
779	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
780	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
781	doesn't execute once).	781	doesn't execute once).
782		782
783	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
784	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
785	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
786	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,
787	call C<end>.	787	call C<end>.
788		788
789	=back	789	=back
…		…
796	=over 4	796	=over 4
797		797
798	=item $cv->recv	798	=item $cv->recv
799		799
800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
801	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
802	normally.	802	normally.
803		803
804	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
805	will return immediately.	805	will return immediately.
806		806
…		…
823	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
824	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
825	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,
826	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
827		827
828	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
829	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
830	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
831	waits otherwise.	831	waits otherwise.
832		832
833	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
838	=item $cb = $cv->cb ($cb->($cv))	838	=item $cb = $cv->cb ($cb->($cv))
839		839
840	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
841	replaces it before doing so.	841	replaces it before doing so.
842		842
843	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
844	"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
845	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
846	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.
847		848
848	=back	849	=back
849		850
850	=head1 SUPPORTED EVENT LOOPS/BACKENDS	851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
851		852
…		…
859	use. If EV is not installed, then AnyEvent will fall back to its own	860	use. If EV is not installed, then AnyEvent will fall back to its own
860	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
861	AnyEvent itself.	862	AnyEvent itself.
862		863
863	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
864	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
865		866
866	=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.
867		868
868	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
869	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
870	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
871	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
872	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.
873		874
…		…
875	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
876	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
877	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
878	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
879	AnyEvent::Impl::Irssi used when running within irssi.	880	AnyEvent::Impl::Irssi used when running within irssi.
		881	AnyEvent::Impl::IOAsync based on IO::Async.
		882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
880		884
881	=item Backends with special needs.	885	=item Backends with special needs.
882		886
883	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
884	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
885	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
886	everything should just work.	890	everything should just work.
887		891
888	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
889		893
890	Support for IO::Async can only be partial, as it is too broken and
891	architecturally limited to even support the AnyEvent API. It also
892	is the only event loop that needs the loop to be set explicitly, so
893	it can only be used by a main program knowing about AnyEvent. See
894	L<AnyEvent::Impl::Async> for the gory details.
895
896	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
897
898	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
899		895
900	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
901		897
902	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.	898	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
…		…
927	Contains C<undef> until the first watcher is being created, before the	923	Contains C<undef> until the first watcher is being created, before the
928	backend has been autodetected.	924	backend has been autodetected.
929		925
930	Afterwards it contains the event model that is being used, which is the	926	Afterwards it contains the event model that is being used, which is the
931	name of the Perl class implementing the model. This class is usually one	927	name of the Perl class implementing the model. This class is usually one
932	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the	928	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
933	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it	929	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
934	will be C<urxvt::anyevent>).	930	will be C<urxvt::anyevent>).
935		931
936	=item AnyEvent::detect	932	=item AnyEvent::detect
937		933
938	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
939	if necessary. You should only call this function right before you would	935	if necessary. You should only call this function right before you would
940	have created an AnyEvent watcher anyway, that is, as late as possible at	936	have created an AnyEvent watcher anyway, that is, as late as possible at
941	runtime, and not e.g. while initialising of your module.	937	runtime, and not e.g. during initialisation of your module.
		938
		939	The effect of calling this function is as if a watcher had been created
		940	(specifically, actions that happen "when the first watcher is created"
		941	happen when calling detetc as well).
942		942
943	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
944	created, use C<post_detect>.	944	created, use C<post_detect>.
945		945
946	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
947		947
948	Arranges for the code block to be executed as soon as the event model is	948	Arranges for the code block to be executed as soon as the event model is
949	autodetected (or immediately if this has already happened).	949	autodetected (or immediately if that has already happened).
950		950
951	The block will be executed I<after> the actual backend has been detected	951	The block will be executed I<after> the actual backend has been detected
952	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been	952	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
953	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do	953	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
954	other initialisations - see the sources of L<AnyEvent::Strict> or	954	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
963	that automatically removes the callback again when it is destroyed (or	963	that automatically removes the callback again when it is destroyed (or
964	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for	964	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
965	a case where this is useful.	965	a case where this is useful.
966		966
967	Example: Create a watcher for the IO::AIO module and store it in	967	Example: Create a watcher for the IO::AIO module and store it in
968	C<$WATCHER>. Only do so after the event loop is initialised, though.	968	C<$WATCHER>, but do so only do so after the event loop is initialised.
969		969
970	our WATCHER;	970	our WATCHER;
971		971
972	my $guard = AnyEvent::post_detect {	972	my $guard = AnyEvent::post_detect {
973	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	973	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
981	$WATCHER \|\|= $guard;	981	$WATCHER \|\|= $guard;
982		982
983	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
984		984
985	If there are any code references in this array (you can C<push> to it	985	If there are any code references in this array (you can C<push> to it
986	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will be called directly
987	the event loop has been chosen.	987	after the event loop has been chosen.
988		988
989	You should check C<$AnyEvent::MODEL> before adding to this array, though:	989	You should check C<$AnyEvent::MODEL> before adding to this array, though:
990	if it is defined then the event loop has already been detected, and the	990	if it is defined then the event loop has already been detected, and the
991	array will be ignored.	991	array will be ignored.
992		992
…		…
1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1010	# as soon as it is	1010	# as soon as it is
1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1012	}	1012	}
1013		1013
		1014	=item AnyEvent::postpone { BLOCK }
		1015
		1016	Arranges for the block to be executed as soon as possible, but not before
		1017	the call itself returns. In practise, the block will be executed just
		1018	before the event loop polls for new events, or shortly afterwards.
		1019
		1020	This function never returns anything (to make the C<return postpone { ...
		1021	}> idiom more useful.
		1022
		1023	To understand the usefulness of this function, consider a function that
		1024	asynchronously does something for you and returns some transaction
		1025	object or guard to let you cancel the operation. For example,
		1026	C<AnyEvent::Socket::tcp_connect>:
		1027
		1028	# start a conenction attempt unless one is active
		1029	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1030	delete $self->{connect_guard};
		1031	...
		1032	};
		1033
		1034	Imagine that this function could instantly call the callback, for
		1035	example, because it detects an obvious error such as a negative port
		1036	number. Invoking the callback before the function returns causes problems
		1037	however: the callback will be called and will try to delete the guard
		1038	object. But since the function hasn't returned yet, there is nothing to
		1039	delete. When the function eventually returns it will assign the guard
		1040	object to C<< $self->{connect_guard} >>, where it will likely never be
		1041	deleted, so the program thinks it is still trying to connect.
		1042
		1043	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1044	callback directly on error:
		1045
		1046	$cb->(undef), return # signal error to callback, BAD!
		1047	if $some_error_condition;
		1048
		1049	It should use C<postpone>:
		1050
		1051	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1052	if $some_error_condition;
		1053
		1054	=item AnyEvent::log $level, $msg[, @args]
		1055
		1056	Log the given C<$msg> at the given C<$level>.
		1057
		1058	Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
		1059	consequently, look at the L<AnyEvent::Log> documentation for details.
		1060
1014	=back	1061	=back
1015		1062
1016	=head1 WHAT TO DO IN A MODULE	1063	=head1 WHAT TO DO IN A MODULE
1017		1064
1018	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1065	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1028	because it will stall the whole program, and the whole point of using	1075	because it will stall the whole program, and the whole point of using
1029	events is to stay interactive.	1076	events is to stay interactive.
1030		1077
1031	It is fine, however, to call C<< ->recv >> when the user of your module	1078	It is fine, however, to call C<< ->recv >> when the user of your module
1032	requests it (i.e. if you create a http request object ad have a method	1079	requests it (i.e. if you create a http request object ad have a method
1033	called C<results> that returns the results, it should call C<< ->recv >>	1080	called C<results> that returns the results, it may call C<< ->recv >>
1034	freely, as the user of your module knows what she is doing. always).	1081	freely, as the user of your module knows what she is doing. Always).
1035		1082
1036	=head1 WHAT TO DO IN THE MAIN PROGRAM	1083	=head1 WHAT TO DO IN THE MAIN PROGRAM
1037		1084
1038	There will always be a single main program - the only place that should	1085	There will always be a single main program - the only place that should
1039	dictate which event model to use.	1086	dictate which event model to use.
1040		1087
1041	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1088	If the program is not event-based, it need not do anything special, even
1042	do anything special (it does not need to be event-based) and let AnyEvent	1089	when it depends on a module that uses an AnyEvent. If the program itself
1043	decide which implementation to chose if some module relies on it.	1090	uses AnyEvent, but does not care which event loop is used, all it needs
		1091	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1092	available loop implementation.
1044		1093
1045	If the main program relies on a specific event model - for example, in	1094	If the main program relies on a specific event model - for example, in
1046	Gtk2 programs you have to rely on the Glib module - you should load the	1095	Gtk2 programs you have to rely on the Glib module - you should load the
1047	event module before loading AnyEvent or any module that uses it: generally	1096	event module before loading AnyEvent or any module that uses it: generally
1048	speaking, you should load it as early as possible. The reason is that	1097	speaking, you should load it as early as possible. The reason is that
1049	modules might create watchers when they are loaded, and AnyEvent will	1098	modules might create watchers when they are loaded, and AnyEvent will
1050	decide on the event model to use as soon as it creates watchers, and it	1099	decide on the event model to use as soon as it creates watchers, and it
1051	might chose the wrong one unless you load the correct one yourself.	1100	might choose the wrong one unless you load the correct one yourself.
1052		1101
1053	You can chose to use a pure-perl implementation by loading the	1102	You can chose to use a pure-perl implementation by loading the
1054	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1103	C<AnyEvent::Loop> module, which gives you similar behaviour
1055	everywhere, but letting AnyEvent chose the model is generally better.	1104	everywhere, but letting AnyEvent chose the model is generally better.
1056		1105
1057	=head2 MAINLOOP EMULATION	1106	=head2 MAINLOOP EMULATION
1058		1107
1059	Sometimes (often for short test scripts, or even standalone programs who	1108	Sometimes (often for short test scripts, or even standalone programs who
…		…
1080		1129
1081	=over 4	1130	=over 4
1082		1131
1083	=item L<AnyEvent::Util>	1132	=item L<AnyEvent::Util>
1084		1133
1085	Contains various utility functions that replace often-used but blocking	1134	Contains various utility functions that replace often-used blocking
1086	functions such as C<inet_aton> by event-/callback-based versions.	1135	functions such as C<inet_aton> with event/callback-based versions.
1087		1136
1088	=item L<AnyEvent::Socket>	1137	=item L<AnyEvent::Socket>
1089		1138
1090	Provides various utility functions for (internet protocol) sockets,	1139	Provides various utility functions for (internet protocol) sockets,
1091	addresses and name resolution. Also functions to create non-blocking tcp	1140	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1093		1142
1094	=item L<AnyEvent::Handle>	1143	=item L<AnyEvent::Handle>
1095		1144
1096	Provide read and write buffers, manages watchers for reads and writes,	1145	Provide read and write buffers, manages watchers for reads and writes,
1097	supports raw and formatted I/O, I/O queued and fully transparent and	1146	supports raw and formatted I/O, I/O queued and fully transparent and
1098	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1147	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1099		1148
1100	=item L<AnyEvent::DNS>	1149	=item L<AnyEvent::DNS>
1101		1150
1102	Provides rich asynchronous DNS resolver capabilities.	1151	Provides rich asynchronous DNS resolver capabilities.
1103		1152
…		…
1111		1160
1112	Here be danger!	1161	Here be danger!
1113		1162
1114	As Pauli would put it, "Not only is it not right, it's not even wrong!" -	1163	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1115	there are so many things wrong with AnyEvent::Handle::UDP, most notably	1164	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1116	it's use of a stream-based API with a protocol that isn't streamable, that	1165	its use of a stream-based API with a protocol that isn't streamable, that
1117	the only way to improve it is to delete it.	1166	the only way to improve it is to delete it.
1118		1167
1119	It features data corruption (but typically only under load) and general	1168	It features data corruption (but typically only under load) and general
1120	confusion. On top, the author is not only clueless about UDP but also	1169	confusion. On top, the author is not only clueless about UDP but also
1121	fact-resistant - some gems of his understanding: "connect doesn't work	1170	fact-resistant - some gems of his understanding: "connect doesn't work
…		…
1125	wrong with his module when it is explained to him.	1174	wrong with his module when it is explained to him.
1126		1175
1127	=item L<AnyEvent::DBI>	1176	=item L<AnyEvent::DBI>
1128		1177
1129	Executes L<DBI> requests asynchronously in a proxy process for you,	1178	Executes L<DBI> requests asynchronously in a proxy process for you,
1130	notifying you in an event-bnased way when the operation is finished.	1179	notifying you in an event-based way when the operation is finished.
1131		1180
1132	=item L<AnyEvent::AIO>	1181	=item L<AnyEvent::AIO>
1133		1182
1134	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1183	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1135	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1184	toolbox of every event programmer. AnyEvent::AIO transparently fuses
…		…
1154		1203
1155	package AnyEvent;	1204	package AnyEvent;
1156		1205
1157	# basically a tuned-down version of common::sense	1206	# basically a tuned-down version of common::sense
1158	sub common_sense {	1207	sub common_sense {
1159	# from common:.sense 1.0	1208	# from common:.sense 3.4
1160	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1209	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1161	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)	1210	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1162	$^H \|= 0x00000600;	1211	$^H \|= 0x00000600;
1163	}	1212	}
1164		1213
1165	BEGIN { AnyEvent::common_sense }	1214	BEGIN { AnyEvent::common_sense }
1166		1215
1167	use Carp ();	1216	use Carp ();
1168		1217
1169	our $VERSION = '5.271';	1218	our $VERSION = '6.01';
1170	our $MODEL;	1219	our $MODEL;
1171		1220
1172	our $AUTOLOAD;
1173	our @ISA;	1221	our @ISA;
1174		1222
1175	our @REGISTRY;	1223	our @REGISTRY;
1176		1224
1177	our $VERBOSE;	1225	our $VERBOSE;
…		…
1183		1231
1184	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1232	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1185	if ${^TAINT};	1233	if ${^TAINT};
1186		1234
1187	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1235	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1188
1189	}	1236	}
1190		1237
1191	our $MAX_SIGNAL_LATENCY = 10;	1238	our $MAX_SIGNAL_LATENCY = 10;
1192		1239
1193	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1240	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1197	$PROTOCOL{$_} = ++$idx	1244	$PROTOCOL{$_} = ++$idx
1198	for reverse split /\s,\s/,	1245	for reverse split /\s,\s/,
1199	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1246	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1200	}	1247	}
1201		1248
		1249	our @post_detect;
		1250
		1251	sub post_detect(&) {
		1252	my ($cb) = @_;
		1253
		1254	push @post_detect, $cb;
		1255
		1256	defined wantarray
		1257	? bless \$cb, "AnyEvent::Util::postdetect"
		1258	: ()
		1259	}
		1260
		1261	sub AnyEvent::Util::postdetect::DESTROY {
		1262	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1263	}
		1264
		1265	our $POSTPONE_W;
		1266	our @POSTPONE;
		1267
		1268	sub _postpone_exec {
		1269	undef $POSTPONE_W;
		1270
		1271	&{ shift @POSTPONE }
		1272	while @POSTPONE;
		1273	}
		1274
		1275	sub postpone(&) {
		1276	push @POSTPONE, shift;
		1277
		1278	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1279
		1280	()
		1281	}
		1282
		1283	sub log($$;@) {
		1284	require AnyEvent::Log;
		1285	# AnyEvent::Log overwrites this function
		1286	goto &log;
		1287	}
		1288
1202	my @models = (	1289	our @models = (
1203	[EV:: => AnyEvent::Impl::EV:: , 1],	1290	[EV:: => AnyEvent::Impl::EV:: , 1],
1204	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1291	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1205	# everything below here will not (normally) be autoprobed	1292	# everything below here will not (normally) be autoprobed
1206	# as the pureperl backend should work everywhere	1293	# as the pure perl backend should work everywhere
1207	# and is usually faster	1294	# and is usually faster
1208	[Event:: => AnyEvent::Impl::Event::, 1],	1295	[Event:: => AnyEvent::Impl::Event::, 1],
1209	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1296	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1210	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1297	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1211	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1298	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1212	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1299	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1213	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1300	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1214	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1301	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1215	[Wx:: => AnyEvent::Impl::POE::],	1302	[Wx:: => AnyEvent::Impl::POE::],
1216	[Prima:: => AnyEvent::Impl::POE::],	1303	[Prima:: => AnyEvent::Impl::POE::],
1217	# IO::Async is just too broken - we would need workarounds for its	1304	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1218	# byzantine signal and broken child handling, among others.	1305	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1219	# IO::Async is rather hard to detect, as it doesn't have any	1306	[FLTK:: => AnyEvent::Impl::FLTK2::],
1220	# obvious default class.
1221	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1222	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1223	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1224	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225	);	1307	);
1226		1308
1227	our %method = map +($_ => 1),	1309	our @isa_hook;
		1310
		1311	sub _isa_set {
		1312	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1313
		1314	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1315	for 1 .. $#pkg;
		1316
		1317	grep $_ && $_->[1], @isa_hook
		1318	and AE::_reset ();
		1319	}
		1320
		1321	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1322	sub _isa_hook($$;$) {
		1323	my ($i, $pkg, $reset_ae) = @_;
		1324
		1325	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1326
		1327	_isa_set;
		1328	}
		1329
		1330	# all autoloaded methods reserve the complete glob, not just the method slot.
		1331	# due to bugs in perls method cache implementation.
1228	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1332	our @methods = qw(io timer time now now_update signal child idle condvar);
1229
1230	our @post_detect;
1231
1232	sub post_detect(&) {
1233	my ($cb) = @_;
1234
1235	push @post_detect, $cb;
1236
1237	defined wantarray
1238	? bless \$cb, "AnyEvent::Util::postdetect"
1239	: ()
1240	}
1241
1242	sub AnyEvent::Util::postdetect::DESTROY {
1243	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1244	}
1245		1333
1246	sub detect() {	1334	sub detect() {
		1335	return $MODEL if $MODEL; # some programs keep references to detect
		1336
		1337	local $!; # for good measure
		1338	local $SIG{__DIE__}; # we use eval
		1339
1247	# free some memory	1340	# free some memory
1248	*detect = sub () { $MODEL };	1341	*detect = sub () { $MODEL };
		1342	# undef &func doesn't correctly update the method cache. grmbl.
		1343	# so we delete the whole glob. grmbl.
		1344	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1345	# a glob with an active sub. hrm. i hope it works, but perl is
		1346	# usually buggy in this department. sigh.
		1347	delete @{"AnyEvent::"}{@methods};
		1348	undef @methods;
1249		1349
1250	local $!; # for good measure
1251	local $SIG{__DIE__};
1252
1253	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1350	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1254	my $model = "AnyEvent::Impl::$1";	1351	my $model = $1;
		1352	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1255	if (eval "require $model") {	1353	if (eval "require $model") {
1256	$MODEL = $model;	1354	$MODEL = $model;
1257	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1355	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
		1356	if $VERBOSE >= 7;
1258	} else {	1357	} else {
1259	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1358	AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1260	}	1359	}
1261	}	1360	}
1262		1361
1263	# check for already loaded models	1362	# check for already loaded models
1264	unless ($MODEL) {	1363	unless ($MODEL) {
1265	for (@REGISTRY, @models) {	1364	for (@REGISTRY, @models) {
1266	my ($package, $model) = @$_;	1365	my ($package, $model) = @$_;
1267	if (${"$package\::VERSION"} > 0) {	1366	if (${"$package\::VERSION"} > 0) {
1268	if (eval "require $model") {	1367	if (eval "require $model") {
1269	$MODEL = $model;	1368	$MODEL = $model;
1270	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1369	AnyEvent::log 7 => "autodetected model '$model', using it."
		1370	if $VERBOSE >= 7;
1271	last;	1371	last;
1272	}	1372	}
1273	}	1373	}
1274	}	1374	}
1275		1375
…		…
1282	and eval "require $package"	1382	and eval "require $package"
1283	and ${"$package\::VERSION"} > 0	1383	and ${"$package\::VERSION"} > 0
1284	and eval "require $model"	1384	and eval "require $model"
1285	) {	1385	) {
1286	$MODEL = $model;	1386	$MODEL = $model;
1287	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;	1387	AnyEvent::log 7 => "autoloaded model '$model', using it."
		1388	if $VERBOSE >= 7;
1288	last;	1389	last;
1289	}	1390	}
1290	}	1391	}
1291		1392
1292	$MODEL	1393	$MODEL
1293	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1394	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1294	}	1395	}
1295	}	1396	}
1296		1397
1297	@models = (); # free probe data	1398	# free memory only needed for probing
		1399	undef @models;
		1400	undef @REGISTRY;
1298		1401
1299	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1402	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1300	unshift @ISA, $MODEL;
1301		1403
1302	# now nuke some methods that are overriden by the backend.	1404	# now nuke some methods that are overridden by the backend.
1303	# SUPER is not allowed.	1405	# SUPER usage is not allowed in these.
1304	for (qw(time signal child idle)) {	1406	for (qw(time signal child idle)) {
1305	undef &{"AnyEvent::Base::$_"}	1407	undef &{"AnyEvent::Base::$_"}
1306	if defined &{"$MODEL\::$_"};	1408	if defined &{"$MODEL\::$_"};
1307	}	1409	}
1308		1410
1309	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1411	_isa_set;
		1412
		1413	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1414	require AnyEvent::Strict;
		1415	}
		1416
		1417	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1418	require AnyEvent::Debug;
		1419	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1420	}
		1421
		1422	if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1423	require AnyEvent::Socket;
		1424	require AnyEvent::Debug;
		1425
		1426	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1427	$shell =~ s/\$\$/$$/g;
		1428
		1429	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1430	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1431	}
1310		1432
1311	(shift @post_detect)->() while @post_detect;	1433	(shift @post_detect)->() while @post_detect;
		1434	undef @post_detect;
1312		1435
1313	*post_detect = sub(&) {	1436	*post_detect = sub(&) {
1314	shift->();	1437	shift->();
1315		1438
1316	undef	1439	undef
1317	};	1440	};
1318		1441
1319	$MODEL	1442	$MODEL
1320	}	1443	}
1321		1444
1322	sub AUTOLOAD {	1445	for my $name (@methods) {
1323	(my $func = $AUTOLOAD) =~ s/.*://;	1446	*$name = sub {
1324
1325	$method{$func}
1326	or Carp::croak "$func: not a valid AnyEvent class method";
1327
1328	detect;	1447	detect;
1329		1448	# we use goto because
1330	my $class = shift;	1449	# a) it makes the thunk more transparent
1331	$class->$func (@_);	1450	# b) it allows us to delete the thunk later
		1451	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1452	};
1332	}	1453	}
1333		1454
1334	# utility function to dup a filehandle. this is used by many backends	1455	# utility function to dup a filehandle. this is used by many backends
1335	# to support binding more than one watcher per filehandle (they usually	1456	# to support binding more than one watcher per filehandle (they usually
1336	# allow only one watcher per fd, so we dup it to get a different one).	1457	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1360		1481
1361	package AE;	1482	package AE;
1362		1483
1363	our $VERSION = $AnyEvent::VERSION;	1484	our $VERSION = $AnyEvent::VERSION;
1364		1485
		1486	sub _reset() {
		1487	eval q{
1365	# fall back to the main API by default - backends and AnyEvent::Base	1488	# fall back to the main API by default - backends and AnyEvent::Base
1366	# implementations can overwrite these.	1489	# implementations can overwrite these.
1367		1490
1368	sub io($$$) {	1491	sub io($$$) {
1369	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1492	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1370	}	1493	}
1371		1494
1372	sub timer($$$) {	1495	sub timer($$$) {
1373	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1496	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1374	}	1497	}
1375		1498
1376	sub signal($$) {	1499	sub signal($$) {
1377	AnyEvent->signal (signal => $_[0], cb => $_[1])	1500	AnyEvent->signal (signal => $_[0], cb => $_[1])
1378	}	1501	}
1379		1502
1380	sub child($$) {	1503	sub child($$) {
1381	AnyEvent->child (pid => $_[0], cb => $_[1])	1504	AnyEvent->child (pid => $_[0], cb => $_[1])
1382	}	1505	}
1383		1506
1384	sub idle($) {	1507	sub idle($) {
1385	AnyEvent->idle (cb => $_[0])	1508	AnyEvent->idle (cb => $_[0]);
1386	}	1509	}
1387		1510
1388	sub cv(;&) {	1511	sub cv(;&) {
1389	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1512	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1390	}	1513	}
1391		1514
1392	sub now() {	1515	sub now() {
1393	AnyEvent->now	1516	AnyEvent->now
1394	}	1517	}
1395		1518
1396	sub now_update() {	1519	sub now_update() {
1397	AnyEvent->now_update	1520	AnyEvent->now_update
1398	}	1521	}
1399		1522
1400	sub time() {	1523	sub time() {
1401	AnyEvent->time	1524	AnyEvent->time
		1525	}
		1526
		1527	*postpone = \&AnyEvent::postpone;
		1528	*log = \&AnyEvent::log;
		1529	};
		1530	die if $@;
1402	}	1531	}
		1532
		1533	BEGIN { _reset }
1403		1534
1404	package AnyEvent::Base;	1535	package AnyEvent::Base;
1405		1536
1406	# default implementations for many methods	1537	# default implementations for many methods
1407		1538
1408	sub time {	1539	sub time {
1409	eval q{ # poor man's autoloading {}	1540	eval q{ # poor man's autoloading {}
1410	# probe for availability of Time::HiRes	1541	# probe for availability of Time::HiRes
1411	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1542	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1412	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1543	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
		1544	if $AnyEvent::VERBOSE >= 8;
		1545	*time = sub { Time::HiRes::time () };
1413	*AE::time = \&Time::HiRes::time;	1546	*AE::time = \& Time::HiRes::time ;
1414	# if (eval "use POSIX (); (POSIX::times())...	1547	# if (eval "use POSIX (); (POSIX::times())...
1415	} else {	1548	} else {
1416	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1549	AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
		1550	*time = sub { CORE::time };
1417	*AE::time = sub (){ time }; # epic fail	1551	*AE::time = sub (){ CORE::time };
1418	}	1552	}
1419		1553
1420	*time = sub { AE::time }; # different prototypes	1554	*now = \&time;
1421	};	1555	};
1422	die if $@;	1556	die if $@;
1423		1557
1424	&time	1558	&time
1425	}	1559	}
1426		1560
1427	*now = \&time;	1561	*now = \&time;
1428
1429	sub now_update { }	1562	sub now_update { }
1430		1563
		1564	sub _poll {
		1565	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1566	}
		1567
1431	# default implementation for ->condvar	1568	# default implementation for ->condvar
		1569	# in fact, the default should not be overwritten
1432		1570
1433	sub condvar {	1571	sub condvar {
1434	eval q{ # poor man's autoloading {}	1572	eval q{ # poor man's autoloading {}
1435	*condvar = sub {	1573	*condvar = sub {
1436	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1574	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1514		1652
1515	sub signal {	1653	sub signal {
1516	eval q{ # poor man's autoloading {}	1654	eval q{ # poor man's autoloading {}
1517	# probe for availability of Async::Interrupt	1655	# probe for availability of Async::Interrupt
1518	if (_have_async_interrupt) {	1656	if (_have_async_interrupt) {
1519	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1657	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
		1658	if $AnyEvent::VERBOSE >= 8;
1520		1659
1521	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1660	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1522	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1661	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1523		1662
1524	} else {	1663	} else {
1525	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1664	AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
		1665	if $AnyEvent::VERBOSE >= 8;
1526		1666
1527	if (AnyEvent::WIN32) {	1667	if (AnyEvent::WIN32) {
1528	require AnyEvent::Util;	1668	require AnyEvent::Util;
1529		1669
1530	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1670	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1606	: sysread $SIGPIPE_R, (my $dummy), 9;	1746	: sysread $SIGPIPE_R, (my $dummy), 9;
1607		1747
1608	while (%SIG_EV) {	1748	while (%SIG_EV) {
1609	for (keys %SIG_EV) {	1749	for (keys %SIG_EV) {
1610	delete $SIG_EV{$_};	1750	delete $SIG_EV{$_};
1611	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1751	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1612	}	1752	}
1613	}	1753	}
1614	};	1754	};
1615	};	1755	};
1616	die if $@;	1756	die if $@;
…		…
1621	# default implementation for ->child	1761	# default implementation for ->child
1622		1762
1623	our %PID_CB;	1763	our %PID_CB;
1624	our $CHLD_W;	1764	our $CHLD_W;
1625	our $CHLD_DELAY_W;	1765	our $CHLD_DELAY_W;
1626	our $WNOHANG;
1627		1766
1628	# used by many Impl's	1767	# used by many Impl's
1629	sub _emit_childstatus($$) {	1768	sub _emit_childstatus($$) {
1630	my (undef, $rpid, $rstatus) = @_;	1769	my (undef, $rpid, $rstatus) = @_;
1631		1770
…		…
1638	eval q{ # poor man's autoloading {}	1777	eval q{ # poor man's autoloading {}
1639	*_sigchld = sub {	1778	*_sigchld = sub {
1640	my $pid;	1779	my $pid;
1641		1780
1642	AnyEvent->_emit_childstatus ($pid, $?)	1781	AnyEvent->_emit_childstatus ($pid, $?)
1643	while ($pid = waitpid -1, $WNOHANG) > 0;	1782	while ($pid = waitpid -1, WNOHANG) > 0;
1644	};	1783	};
1645		1784
1646	*child = sub {	1785	*child = sub {
1647	my (undef, %arg) = @_;	1786	my (undef, %arg) = @_;
1648		1787
1649	defined (my $pid = $arg{pid} + 0)	1788	my $pid = $arg{pid};
1650	or Carp::croak "required option 'pid' is missing";	1789	my $cb = $arg{cb};
1651		1790
1652	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1791	$PID_CB{$pid}{$cb+0} = $cb;
1653
1654	# WNOHANG is almost cetrainly 1 everywhere
1655	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1656	? 1
1657	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1658		1792
1659	unless ($CHLD_W) {	1793	unless ($CHLD_W) {
1660	$CHLD_W = AE::signal CHLD => \&_sigchld;	1794	$CHLD_W = AE::signal CHLD => \&_sigchld;
1661	# child could be a zombie already, so make at least one round	1795	# child could be a zombie already, so make at least one round
1662	&_sigchld;	1796	&_sigchld;
1663	}	1797	}
1664		1798
1665	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1799	bless [$pid, $cb+0], "AnyEvent::Base::child"
1666	};	1800	};
1667		1801
1668	*AnyEvent::Base::child::DESTROY = sub {	1802	*AnyEvent::Base::child::DESTROY = sub {
1669	my ($pid, $cb) = @{$_[0]};	1803	my ($pid, $icb) = @{$_[0]};
1670		1804
1671	delete $PID_CB{$pid}{$cb};	1805	delete $PID_CB{$pid}{$icb};
1672	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1806	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1673		1807
1674	undef $CHLD_W unless keys %PID_CB;	1808	undef $CHLD_W unless keys %PID_CB;
1675	};	1809	};
1676	};	1810	};
…		…
1689		1823
1690	my ($cb, $w, $rcb) = $arg{cb};	1824	my ($cb, $w, $rcb) = $arg{cb};
1691		1825
1692	$rcb = sub {	1826	$rcb = sub {
1693	if ($cb) {	1827	if ($cb) {
1694	$w = _time;	1828	$w = AE::time;
1695	&$cb;	1829	&$cb;
1696	$w = _time - $w;	1830	$w = AE::time - $w;
1697		1831
1698	# never use more then 50% of the time for the idle watcher,	1832	# never use more then 50% of the time for the idle watcher,
1699	# within some limits	1833	# within some limits
1700	$w = 0.0001 if $w < 0.0001;	1834	$w = 0.0001 if $w < 0.0001;
1701	$w = 5 if $w > 5;	1835	$w = 5 if $w > 5;
…		…
1724		1858
1725	package AnyEvent::CondVar;	1859	package AnyEvent::CondVar;
1726		1860
1727	our @ISA = AnyEvent::CondVar::Base::;	1861	our @ISA = AnyEvent::CondVar::Base::;
1728		1862
		1863	# only to be used for subclassing
		1864	sub new {
		1865	my $class = shift;
		1866	bless AnyEvent->condvar (@_), $class
		1867	}
		1868
1729	package AnyEvent::CondVar::Base;	1869	package AnyEvent::CondVar::Base;
1730		1870
1731	#use overload	1871	#use overload
1732	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1872	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1733	# fallback => 1;	1873	# fallback => 1;
…		…
1742		1882
1743	sub _send {	1883	sub _send {
1744	# nop	1884	# nop
1745	}	1885	}
1746		1886
		1887	sub _wait {
		1888	AnyEvent->_poll until $_[0]{_ae_sent};
		1889	}
		1890
1747	sub send {	1891	sub send {
1748	my $cv = shift;	1892	my $cv = shift;
1749	$cv->{_ae_sent} = [@_];	1893	$cv->{_ae_sent} = [@_];
1750	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1894	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1751	$cv->_send;	1895	$cv->_send;
…		…
1758		1902
1759	sub ready {	1903	sub ready {
1760	$_[0]{_ae_sent}	1904	$_[0]{_ae_sent}
1761	}	1905	}
1762		1906
1763	sub _wait {
1764	$WAITING
1765	and !$_[0]{_ae_sent}
1766	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1767
1768	local $WAITING = 1;
1769	AnyEvent->one_event while !$_[0]{_ae_sent};
1770	}
1771
1772	sub recv {	1907	sub recv {
		1908	unless ($_[0]{_ae_sent}) {
		1909	$WAITING
		1910	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1911
		1912	local $WAITING = 1;
1773	$_[0]->_wait;	1913	$_[0]->_wait;
		1914	}
1774		1915
1775	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1916	$_[0]{_ae_croak}
1776	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1917	and Carp::croak $_[0]{_ae_croak};
		1918
		1919	wantarray
		1920	? @{ $_[0]{_ae_sent} }
		1921	: $_[0]{_ae_sent}[0]
1777	}	1922	}
1778		1923
1779	sub cb {	1924	sub cb {
1780	my $cv = shift;	1925	my $cv = shift;
1781		1926
…		…
1797	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1942	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1798	}	1943	}
1799		1944
1800	# undocumented/compatibility with pre-3.4	1945	# undocumented/compatibility with pre-3.4
1801	*broadcast = \&send;	1946	*broadcast = \&send;
1802	*wait = \&_wait;	1947	*wait = \&recv;
1803		1948
1804	=head1 ERROR AND EXCEPTION HANDLING	1949	=head1 ERROR AND EXCEPTION HANDLING
1805		1950
1806	In general, AnyEvent does not do any error handling - it relies on the	1951	In general, AnyEvent does not do any error handling - it relies on the
1807	caller to do that if required. The L<AnyEvent::Strict> module (see also	1952	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1834		1979
1835	By default, AnyEvent will be completely silent except in fatal	1980	By default, AnyEvent will be completely silent except in fatal
1836	conditions. You can set this environment variable to make AnyEvent more	1981	conditions. You can set this environment variable to make AnyEvent more
1837	talkative.	1982	talkative.
1838		1983
1839	When set to C<1> or higher, causes AnyEvent to warn about unexpected	1984	When set to C<5> or higher, causes AnyEvent to warn about unexpected
1840	conditions, such as not being able to load the event model specified by	1985	conditions, such as not being able to load the event model specified by
1841	C<PERL_ANYEVENT_MODEL>.	1986	C<PERL_ANYEVENT_MODEL>.
1842		1987
1843	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1988	When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1844	model it chooses.	1989	model it chooses.
1845		1990
1846	When set to C<8> or higher, then AnyEvent will report extra information on	1991	When set to C<8> or higher, then AnyEvent will report extra information on
1847	which optional modules it loads and how it implements certain features.	1992	which optional modules it loads and how it implements certain features.
1848		1993
…		…
1854	check the arguments passed to most method calls. If it finds any problems,	1999	check the arguments passed to most method calls. If it finds any problems,
1855	it will croak.	2000	it will croak.
1856		2001
1857	In other words, enables "strict" mode.	2002	In other words, enables "strict" mode.
1858		2003
1859	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	2004	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1860	>>, it is definitely recommended to keep it off in production. Keeping	2005	>>, it is definitely recommended to keep it off in production. Keeping
1861	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2006	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1862	can be very useful, however.	2007	can be very useful, however.
1863		2008
		2009	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2010
		2011	If this env variable is set, then its contents will be interpreted by
		2012	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2013	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2014	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2015
		2016	This takes place when the first watcher is created.
		2017
		2018	For example, to bind a debug shell on a unix domain socket in
		2019	F<< /tmp/debug<pid>.sock >>, you could use this:
		2020
		2021	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2022
		2023	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2024	systems.
		2025
		2026	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2027
		2028	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2029	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2030
1864	=item C<PERL_ANYEVENT_MODEL>	2031	=item C<PERL_ANYEVENT_MODEL>
1865		2032
1866	This can be used to specify the event model to be used by AnyEvent, before	2033	This can be used to specify the event model to be used by AnyEvent, before
1867	auto detection and -probing kicks in. It must be a string consisting	2034	auto detection and -probing kicks in.
1868	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2035
		2036	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2037	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1869	and the resulting module name is loaded and if the load was successful,	2038	resulting module name is loaded and - if the load was successful - used as
1870	used as event model. If it fails to load AnyEvent will proceed with	2039	event model backend. If it fails to load then AnyEvent will proceed with
1871	auto detection and -probing.	2040	auto detection and -probing.
1872		2041
1873	This functionality might change in future versions.	2042	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2043	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2044	the end of a string designates a module name and quotes it appropriately).
1874		2045
1875	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2046	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1876	could start your program like this:	2047	could start your program like this:
1877		2048
1878	PERL_ANYEVENT_MODEL=Perl perl ...	2049	PERL_ANYEVENT_MODEL=Perl perl ...
1879		2050
1880	=item C<PERL_ANYEVENT_PROTOCOLS>	2051	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2270	(even when used without AnyEvent), but most event loops have acceptable	2441	(even when used without AnyEvent), but most event loops have acceptable
2271	performance with or without AnyEvent.	2442	performance with or without AnyEvent.
2272		2443
2273	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2444	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2274	the actual event loop, only with extremely fast event loops such as EV	2445	the actual event loop, only with extremely fast event loops such as EV
2275	adds AnyEvent significant overhead.	2446	does AnyEvent add significant overhead.
2276		2447
2277	=item * You should avoid POE like the plague if you want performance or	2448	=item * You should avoid POE like the plague if you want performance or
2278	reasonable memory usage.	2449	reasonable memory usage.
2279		2450
2280	=back	2451	=back
…		…
2510	unless defined $SIG{PIPE};	2681	unless defined $SIG{PIPE};
2511		2682
2512	=head1 RECOMMENDED/OPTIONAL MODULES	2683	=head1 RECOMMENDED/OPTIONAL MODULES
2513		2684
2514	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2685	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2515	it's built-in modules) are required to use it.	2686	its built-in modules) are required to use it.
2516		2687
2517	That does not mean that AnyEvent won't take advantage of some additional	2688	That does not mean that AnyEvent won't take advantage of some additional
2518	modules if they are installed.	2689	modules if they are installed.
2519		2690
2520	This section explains which additional modules will be used, and how they	2691	This section explains which additional modules will be used, and how they
…		…
2578	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2749	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2579		2750
2580	=item L<Time::HiRes>	2751	=item L<Time::HiRes>
2581		2752
2582	This module is part of perl since release 5.008. It will be used when the	2753	This module is part of perl since release 5.008. It will be used when the
2583	chosen event library does not come with a timing source on it's own. The	2754	chosen event library does not come with a timing source of its own. The
2584	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2755	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2585	try to use a monotonic clock for timing stability.	2756	try to use a monotonic clock for timing stability.
2586		2757
2587	=back	2758	=back
2588		2759
2589		2760
…		…
2651	pronounced).	2822	pronounced).
2652		2823
2653		2824
2654	=head1 SEE ALSO	2825	=head1 SEE ALSO
2655		2826
2656	Utility functions: L<AnyEvent::Util>.	2827	Tutorial/Introduction: L<AnyEvent::Intro>.
2657		2828
2658	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2829	FAQ: L<AnyEvent::FAQ>.
2659	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2830
		2831	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2832	(simply logging).
		2833
		2834	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2835	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2836
		2837	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2838	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2839	L<Qt>, L<POE>, L<FLTK>.
2660		2840
2661	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2841	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2662	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2842	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2663	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2843	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2664	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2844	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2845	L<AnyEvent::Impl::FLTK>.
2665		2846
2666	Non-blocking file handles, sockets, TCP clients and	2847	Non-blocking handles, pipes, stream sockets, TCP clients and
2667	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2848	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2668		2849
2669	Asynchronous DNS: L<AnyEvent::DNS>.	2850	Asynchronous DNS: L<AnyEvent::DNS>.
2670		2851
2671	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2852	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2672	L<Coro::Event>,
2673		2853
2674	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2854	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2675	L<AnyEvent::HTTP>.	2855	L<AnyEvent::HTTP>.
2676		2856
2677		2857
2678	=head1 AUTHOR	2858	=head1 AUTHOR
2679		2859

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.329 by root, Sun Jul 11 05:44:22 2010 UTC vs. Revision 1.365 by root, Tue Aug 16 14:47:26 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.329 by root, Sun Jul 11 05:44:22 2010 UTC vs.
Revision 1.365 by root, Tue Aug 16 14:47:26 2011 UTC