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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.323 by root, Thu May 20 21:22:20 2010 UTC vs.
Revision 1.369 by root, Wed Aug 17 02:32:01 2011 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - the DBI of event loop programming	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6	and POE are various supported event loops/environments.	6	FLTK and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
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
…		…
138	use AnyEvent;	138	use AnyEvent;
139		139
140	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
141		141
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. Maybe you should tell their authors to	143	starts using it, all bets are off - this case should be very rare though,
144	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
145		146
146	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
147	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
148	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
149		150
150	=head1 WATCHERS	151	=head1 WATCHERS
151		152
152	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
153	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
…		…
158	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
159	is in control).	160	is in control).
160		161
161	Note that B<callbacks must not permanently change global variables>	162	Note that B<callbacks must not permanently change global variables>
162	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<<
163	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
164	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
165	widely between event loops.	166	widely between event loops.
166		167
167	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
168	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
169	to it).	170	to it).
170		171
171	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.
172		173
173	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
174	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.
175		176
176	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
177		178
178	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
179	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
180	undef $w;	181	undef $w;
181	});	182	});
…		…
213		214
214	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.
215	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
216	underlying file descriptor.	217	underlying file descriptor.
217		218
218	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
219	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
220	handles.	221	handles.
221		222
222	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
223	watcher.	224	watcher.
…		…
247		248
248	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
249	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
250	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
251		252
252	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
253	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
254	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
255	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
256	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.
257		258
258	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
259	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
260	only approximate.	261	only approximate.
261		262
262	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
263		264
264	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
282		283
283	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
284	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
285	"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
286	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
287	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.
288		289
289	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
290	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
291	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)
292	timers.	293	timers.
293		294
294	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
295	AnyEvent API.	296	AnyEvent API.
…		…
317	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
318	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
319		320
320	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
321	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
322	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
323		324
324	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
325	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
326		327
327	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>
328	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
329		330
330	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
331	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
332	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
333	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
334	after three seconds.	335	after three seconds.
335		336
…		…
355	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
356	account.	357	account.
357		358
358	=item AnyEvent->now_update	359	=item AnyEvent->now_update
359		360
360	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
361	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 >>,
362	AnyEvent->now >>, above).	363	above).
363		364
364	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
365	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
366	might affect timers and time-outs.	367	might affect timers and time-outs.
367		368
…		…
428	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
429		430
430	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
431	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
432	do race-free signal handling in perl, requiring C libraries for	433	do race-free signal handling in perl, requiring C libraries for
433	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,
434	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
435	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
436	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,
437	and should be left alone otherwise. This variable determines how often	438	and should be left alone otherwise. This variable determines how often
438	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
…		…
440	saving.	441	saving.
441		442
442	All these problems can be avoided by installing the optional	443	All these problems can be avoided by installing the optional
443	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
444	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>
445	(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
446	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.
447		448
448	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
449		450
450	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
451		452
452	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.
453		454
454	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,
455	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
456	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
457	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
458	(stopped/continued).	459	(stopped/continued).
459		460
…		…
481	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
482	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
483	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
484		485
485	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
486	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
487	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
488		489
489	Example: fork a process and wait for it	490	Example: fork a process and wait for it
490		491
491	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
492		493
…		…
506		507
507	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
508		509
509	$w = AnyEvent->idle (cb => <callback>);	510	$w = AnyEvent->idle (cb => <callback>);
510		511
511	Repeatedly invoke the callback after the process becomes idle, until	512	This will repeatedly invoke the callback after the process becomes idle,
512	either the watcher is destroyed or new events have been detected.	513	until either the watcher is destroyed or new events have been detected.
513		514
514	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
515	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
516	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
517	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
…		…
556	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
557		558
558	AnyEvent is slightly different: it expects somebody else to run the event	559	AnyEvent is slightly different: it expects somebody else to run the event
559	loop and will only block when necessary (usually when told by the user).	560	loop and will only block when necessary (usually when told by the user).
560		561
561	The instrument to do that is called a "condition variable", so called	562	The tool to do that is called a "condition variable", so called because
562	because they represent a condition that must become true.	563	they represent a condition that must become true.
563		564
564	Now is probably a good time to look at the examples further below.	565	Now is probably a good time to look at the examples further below.
565		566
566	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
567	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
…		…
572	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
573	by calling the C<send> method (or calling the condition variable as if it	574	by calling the C<send> method (or calling the condition variable as if it
574	were a callback, read about the caveats in the description for the C<<	575	were a callback, read about the caveats in the description for the C<<
575	->send >> method).	576	->send >> method).
576		577
577	Condition variables are similar to callbacks, except that you can	578	Since condition variables are the most complex part of the AnyEvent API, here are
578	optionally wait for them. They can also be called merge points - points	579	some different mental models of what they are - pick the ones you can connect to:
579	in time where multiple outstanding events have been processed. And yet	580
580	another way to call them is transactions - each condition variable can be	581	=over 4
581	used to represent a transaction, which finishes at some point and delivers	582
582	a result. And yet some people know them as "futures" - a promise to	583	=item * Condition variables are like callbacks - you can call them (and pass them instead
583	compute/deliver something that you can wait for.	584	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		585
		586	=item * Condition variables are signals - one side can emit or send them,
		587	the other side can wait for them, or install a handler that is called when
		588	the signal fires.
		589
		590	=item * Condition variables are like "Merge Points" - points in your program
		591	where you merge multiple independent results/control flows into one.
		592
		593	=item * Condition variables represent a transaction - functions that start
		594	some kind of transaction can return them, leaving the caller the choice
		595	between waiting in a blocking fashion, or setting a callback.
		596
		597	=item * Condition variables represent future values, or promises to deliver
		598	some result, long before the result is available.
		599
		600	=back
584		601
585	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
586	for example, if you write a module that does asynchronous http requests,	603	for example, if you write a module that does asynchronous http requests,
587	then a condition variable would be the ideal candidate to signal the	604	then a condition variable would be the ideal candidate to signal the
588	availability of results. The user can either act when the callback is	605	availability of results. The user can either act when the callback is
…		…
601		618
602	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
603	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
604	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
605	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
606	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
607		624
608	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
609	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
610	for the send to occur.	627	for the send to occur.
611		628
…		…
676	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
677	C<send>.	694	C<send>.
678		695
679	=item $cv->croak ($error)	696	=item $cv->croak ($error)
680		697
681	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
682	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
683		700
684	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
685	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
686	delays the error detetcion, but has the overwhelmign advantage that it	703	delays the error detection, but has the overwhelming advantage that it
687	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
688	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
689	the problem.	706	the problem.
690		707
691	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
692		709
693	=item $cv->end	710	=item $cv->end
…		…
731	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
732	sending.	749	sending.
733		750
734	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
735	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
736	begung can potentially be zero:	753	begun can potentially be zero:
737		754
738	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
739		756
740	my %result;	757	my %result;
741	$cv->begin (sub { shift->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
…		…
762	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
763	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
764	doesn't execute once).	781	doesn't execute once).
765		782
766	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
767	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
768	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
769	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,
770	call C<end>.	787	call C<end>.
771		788
772	=back	789	=back
…		…
779	=over 4	796	=over 4
780		797
781	=item $cv->recv	798	=item $cv->recv
782		799
783	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
784	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
785	normally.	802	normally.
786		803
787	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
788	will return immediately.	805	will return immediately.
789		806
…		…
806	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
807	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
808	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,
809	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
810		827
811	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
812	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
813	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
814	waits otherwise.	831	waits otherwise.
815		832
816	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
821	=item $cb = $cv->cb ($cb->($cv))	838	=item $cb = $cv->cb ($cb->($cv))
822		839
823	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
824	replaces it before doing so.	841	replaces it before doing so.
825		842
826	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
827	"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
828	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
829	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.
830		848
831	=back	849	=back
832		850
833	=head1 SUPPORTED EVENT LOOPS/BACKENDS	851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
834		852
…		…
842	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
843	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
844	AnyEvent itself.	862	AnyEvent itself.
845		863
846	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
847	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
848		866
849	=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.
850		868
851	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
852	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
853	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
854	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
855	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.
856		874
…		…
858	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
859	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
860	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
861	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
862	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).
863		884
864	=item Backends with special needs.	885	=item Backends with special needs.
865		886
866	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
867	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
868	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
869	everything should just work.	890	everything should just work.
870		891
871	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
872		893
873	Support for IO::Async can only be partial, as it is too broken and
874	architecturally limited to even support the AnyEvent API. It also
875	is the only event loop that needs the loop to be set explicitly, so
876	it can only be used by a main program knowing about AnyEvent. See
877	L<AnyEvent::Impl::Async> for the gory details.
878
879	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
880
881	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
882		895
883	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
884		897
885	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>.
…		…
910	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
911	backend has been autodetected.	924	backend has been autodetected.
912		925
913	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
914	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
915	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
916	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
917	will be C<urxvt::anyevent>).	930	will be C<urxvt::anyevent>).
918		931
919	=item AnyEvent::detect	932	=item AnyEvent::detect
920		933
921	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
922	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
923	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
924	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).
925		942
926	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
927	created, use C<post_detect>.	944	created, use C<post_detect>.
928		945
929	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
930		947
931	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
932	autodetected (or immediately if this has already happened).	949	autodetected (or immediately if that has already happened).
933		950
934	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
935	(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
936	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
937	other initialisations - see the sources of L<AnyEvent::Strict> or	954	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
946	that automatically removes the callback again when it is destroyed (or	963	that automatically removes the callback again when it is destroyed (or
947	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
948	a case where this is useful.	965	a case where this is useful.
949		966
950	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
951	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.
952		969
953	our WATCHER;	970	our WATCHER;
954		971
955	my $guard = AnyEvent::post_detect {	972	my $guard = AnyEvent::post_detect {
956	$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);
…		…
964	$WATCHER \|\|= $guard;	981	$WATCHER \|\|= $guard;
965		982
966	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
967		984
968	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
969	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will be called directly
970	the event loop has been chosen.	987	after the event loop has been chosen.
971		988
972	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:
973	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
974	array will be ignored.	991	array will be ignored.
975		992
…		…
992	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
993	# as soon as it is	1010	# as soon as it is
994	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
995	}	1012	}
996		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
		1061	If you want to sprinkle loads of logging calls around your code, consider
		1062	creating a logger callback with the C<AnyEvent::Log::logger< function.
		1063
997	=back	1064	=back
998		1065
999	=head1 WHAT TO DO IN A MODULE	1066	=head1 WHAT TO DO IN A MODULE
1000		1067
1001	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1068	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1011	because it will stall the whole program, and the whole point of using	1078	because it will stall the whole program, and the whole point of using
1012	events is to stay interactive.	1079	events is to stay interactive.
1013		1080
1014	It is fine, however, to call C<< ->recv >> when the user of your module	1081	It is fine, however, to call C<< ->recv >> when the user of your module
1015	requests it (i.e. if you create a http request object ad have a method	1082	requests it (i.e. if you create a http request object ad have a method
1016	called C<results> that returns the results, it should call C<< ->recv >>	1083	called C<results> that returns the results, it may call C<< ->recv >>
1017	freely, as the user of your module knows what she is doing. always).	1084	freely, as the user of your module knows what she is doing. Always).
1018		1085
1019	=head1 WHAT TO DO IN THE MAIN PROGRAM	1086	=head1 WHAT TO DO IN THE MAIN PROGRAM
1020		1087
1021	There will always be a single main program - the only place that should	1088	There will always be a single main program - the only place that should
1022	dictate which event model to use.	1089	dictate which event model to use.
1023		1090
1024	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1091	If the program is not event-based, it need not do anything special, even
1025	do anything special (it does not need to be event-based) and let AnyEvent	1092	when it depends on a module that uses an AnyEvent. If the program itself
1026	decide which implementation to chose if some module relies on it.	1093	uses AnyEvent, but does not care which event loop is used, all it needs
		1094	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1095	available loop implementation.
1027		1096
1028	If the main program relies on a specific event model - for example, in	1097	If the main program relies on a specific event model - for example, in
1029	Gtk2 programs you have to rely on the Glib module - you should load the	1098	Gtk2 programs you have to rely on the Glib module - you should load the
1030	event module before loading AnyEvent or any module that uses it: generally	1099	event module before loading AnyEvent or any module that uses it: generally
1031	speaking, you should load it as early as possible. The reason is that	1100	speaking, you should load it as early as possible. The reason is that
1032	modules might create watchers when they are loaded, and AnyEvent will	1101	modules might create watchers when they are loaded, and AnyEvent will
1033	decide on the event model to use as soon as it creates watchers, and it	1102	decide on the event model to use as soon as it creates watchers, and it
1034	might chose the wrong one unless you load the correct one yourself.	1103	might choose the wrong one unless you load the correct one yourself.
1035		1104
1036	You can chose to use a pure-perl implementation by loading the	1105	You can chose to use a pure-perl implementation by loading the
1037	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1106	C<AnyEvent::Loop> module, which gives you similar behaviour
1038	everywhere, but letting AnyEvent chose the model is generally better.	1107	everywhere, but letting AnyEvent chose the model is generally better.
1039		1108
1040	=head2 MAINLOOP EMULATION	1109	=head2 MAINLOOP EMULATION
1041		1110
1042	Sometimes (often for short test scripts, or even standalone programs who	1111	Sometimes (often for short test scripts, or even standalone programs who
…		…
1055		1124
1056		1125
1057	=head1 OTHER MODULES	1126	=head1 OTHER MODULES
1058		1127
1059	The following is a non-exhaustive list of additional modules that use	1128	The following is a non-exhaustive list of additional modules that use
1060	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1129	AnyEvent as a client and can therefore be mixed easily with other
1061	modules and other event loops in the same program. Some of the modules	1130	AnyEvent modules and other event loops in the same program. Some of the
1062	come with AnyEvent, most are available via CPAN.	1131	modules come as part of AnyEvent, the others are available via CPAN (see
		1132	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1133	a longer non-exhaustive list), and the list is heavily biased towards
		1134	modules of the AnyEvent author himself :)
1063		1135
1064	=over 4	1136	=over 4
1065		1137
1066	=item L<AnyEvent::Util>	1138	=item L<AnyEvent::Util>
1067		1139
1068	Contains various utility functions that replace often-used but blocking	1140	Contains various utility functions that replace often-used blocking
1069	functions such as C<inet_aton> by event-/callback-based versions.	1141	functions such as C<inet_aton> with event/callback-based versions.
1070		1142
1071	=item L<AnyEvent::Socket>	1143	=item L<AnyEvent::Socket>
1072		1144
1073	Provides various utility functions for (internet protocol) sockets,	1145	Provides various utility functions for (internet protocol) sockets,
1074	addresses and name resolution. Also functions to create non-blocking tcp	1146	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1076		1148
1077	=item L<AnyEvent::Handle>	1149	=item L<AnyEvent::Handle>
1078		1150
1079	Provide read and write buffers, manages watchers for reads and writes,	1151	Provide read and write buffers, manages watchers for reads and writes,
1080	supports raw and formatted I/O, I/O queued and fully transparent and	1152	supports raw and formatted I/O, I/O queued and fully transparent and
1081	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1153	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1082		1154
1083	=item L<AnyEvent::DNS>	1155	=item L<AnyEvent::DNS>
1084		1156
1085	Provides rich asynchronous DNS resolver capabilities.	1157	Provides rich asynchronous DNS resolver capabilities.
1086		1158
…		…
1094		1166
1095	Here be danger!	1167	Here be danger!
1096		1168
1097	As Pauli would put it, "Not only is it not right, it's not even wrong!" -	1169	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1098	there are so many things wrong with AnyEvent::Handle::UDP, most notably	1170	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1099	it's use of a stream-based API with a protocol that isn't streamable, that	1171	its use of a stream-based API with a protocol that isn't streamable, that
1100	the only way to improve it is to delete it.	1172	the only way to improve it is to delete it.
1101		1173
1102	It features data corruption (but typically only under load) and general	1174	It features data corruption (but typically only under load) and general
1103	confusion. On top, the author is not only clueless about UDP but also	1175	confusion. On top, the author is not only clueless about UDP but also
1104	fact-resistant - some gems of his understanding: "connect doesn't work	1176	fact-resistant - some gems of his understanding: "connect doesn't work
…		…
1108	wrong with his module when it is explained to him.	1180	wrong with his module when it is explained to him.
1109		1181
1110	=item L<AnyEvent::DBI>	1182	=item L<AnyEvent::DBI>
1111		1183
1112	Executes L<DBI> requests asynchronously in a proxy process for you,	1184	Executes L<DBI> requests asynchronously in a proxy process for you,
1113	notifying you in an event-bnased way when the operation is finished.	1185	notifying you in an event-based way when the operation is finished.
1114		1186
1115	=item L<AnyEvent::AIO>	1187	=item L<AnyEvent::AIO>
1116		1188
1117	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1189	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1118	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1190	toolbox of every event programmer. AnyEvent::AIO transparently fuses
…		…
1137		1209
1138	package AnyEvent;	1210	package AnyEvent;
1139		1211
1140	# basically a tuned-down version of common::sense	1212	# basically a tuned-down version of common::sense
1141	sub common_sense {	1213	sub common_sense {
1142	# from common:.sense 1.0	1214	# from common:.sense 3.4
1143	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1215	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1144	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)	1216	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1145	$^H \|= 0x00000600;	1217	$^H \|= 0x00000600;
1146	}	1218	}
1147		1219
1148	BEGIN { AnyEvent::common_sense }	1220	BEGIN { AnyEvent::common_sense }
1149		1221
1150	use Carp ();	1222	use Carp ();
1151		1223
1152	our $VERSION = '5.261';	1224	our $VERSION = '6.01';
1153	our $MODEL;	1225	our $MODEL;
1154		1226
1155	our $AUTOLOAD;
1156	our @ISA;	1227	our @ISA;
1157		1228
1158	our @REGISTRY;	1229	our @REGISTRY;
1159		1230
1160	our $VERBOSE;	1231	our $VERBOSE;
…		…
1166		1237
1167	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1238	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1168	if ${^TAINT};	1239	if ${^TAINT};
1169		1240
1170	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1241	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1171
1172	}	1242	}
1173		1243
1174	our $MAX_SIGNAL_LATENCY = 10;	1244	our $MAX_SIGNAL_LATENCY = 10;
1175		1245
1176	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1246	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1180	$PROTOCOL{$_} = ++$idx	1250	$PROTOCOL{$_} = ++$idx
1181	for reverse split /\s,\s/,	1251	for reverse split /\s,\s/,
1182	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1252	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1183	}	1253	}
1184		1254
		1255	our @post_detect;
		1256
		1257	sub post_detect(&) {
		1258	my ($cb) = @_;
		1259
		1260	push @post_detect, $cb;
		1261
		1262	defined wantarray
		1263	? bless \$cb, "AnyEvent::Util::postdetect"
		1264	: ()
		1265	}
		1266
		1267	sub AnyEvent::Util::postdetect::DESTROY {
		1268	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1269	}
		1270
		1271	our $POSTPONE_W;
		1272	our @POSTPONE;
		1273
		1274	sub _postpone_exec {
		1275	undef $POSTPONE_W;
		1276
		1277	&{ shift @POSTPONE }
		1278	while @POSTPONE;
		1279	}
		1280
		1281	sub postpone(&) {
		1282	push @POSTPONE, shift;
		1283
		1284	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1285
		1286	()
		1287	}
		1288
		1289	sub log($$;@) {
		1290	require AnyEvent::Log;
		1291	# AnyEvent::Log overwrites this function
		1292	goto &log;
		1293	}
		1294
1185	my @models = (	1295	our @models = (
1186	[EV:: => AnyEvent::Impl::EV:: , 1],	1296	[EV:: => AnyEvent::Impl::EV:: , 1],
1187	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1297	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1188	# everything below here will not (normally) be autoprobed	1298	# everything below here will not (normally) be autoprobed
1189	# as the pureperl backend should work everywhere	1299	# as the pure perl backend should work everywhere
1190	# and is usually faster	1300	# and is usually faster
1191	[Event:: => AnyEvent::Impl::Event::, 1],	1301	[Event:: => AnyEvent::Impl::Event::, 1],
1192	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1302	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1193	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1303	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1194	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1304	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1195	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1305	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1196	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1306	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1197	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1307	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1198	[Wx:: => AnyEvent::Impl::POE::],	1308	[Wx:: => AnyEvent::Impl::POE::],
1199	[Prima:: => AnyEvent::Impl::POE::],	1309	[Prima:: => AnyEvent::Impl::POE::],
1200	# IO::Async is just too broken - we would need workarounds for its	1310	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1201	# byzantine signal and broken child handling, among others.	1311	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1202	# IO::Async is rather hard to detect, as it doesn't have any	1312	[FLTK:: => AnyEvent::Impl::FLTK2::],
1203	# obvious default class.
1204	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1205	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1206	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1207	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1208	);	1313	);
1209		1314
1210	our %method = map +($_ => 1),	1315	our @isa_hook;
		1316
		1317	sub _isa_set {
		1318	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1319
		1320	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1321	for 1 .. $#pkg;
		1322
		1323	grep $_ && $_->[1], @isa_hook
		1324	and AE::_reset ();
		1325	}
		1326
		1327	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1328	sub _isa_hook($$;$) {
		1329	my ($i, $pkg, $reset_ae) = @_;
		1330
		1331	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1332
		1333	_isa_set;
		1334	}
		1335
		1336	# all autoloaded methods reserve the complete glob, not just the method slot.
		1337	# due to bugs in perls method cache implementation.
1211	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1338	our @methods = qw(io timer time now now_update signal child idle condvar);
1212
1213	our @post_detect;
1214
1215	sub post_detect(&) {
1216	my ($cb) = @_;
1217
1218	push @post_detect, $cb;
1219
1220	defined wantarray
1221	? bless \$cb, "AnyEvent::Util::postdetect"
1222	: ()
1223	}
1224
1225	sub AnyEvent::Util::postdetect::DESTROY {
1226	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1227	}
1228		1339
1229	sub detect() {	1340	sub detect() {
		1341	return $MODEL if $MODEL; # some programs keep references to detect
		1342
		1343	local $!; # for good measure
		1344	local $SIG{__DIE__}; # we use eval
		1345
1230	# free some memory	1346	# free some memory
1231	*detect = sub () { $MODEL };	1347	*detect = sub () { $MODEL };
		1348	# undef &func doesn't correctly update the method cache. grmbl.
		1349	# so we delete the whole glob. grmbl.
		1350	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1351	# a glob with an active sub. hrm. i hope it works, but perl is
		1352	# usually buggy in this department. sigh.
		1353	delete @{"AnyEvent::"}{@methods};
		1354	undef @methods;
1232		1355
1233	local $!; # for good measure
1234	local $SIG{__DIE__};
1235
1236	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1356	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1237	my $model = "AnyEvent::Impl::$1";	1357	my $model = $1;
		1358	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1238	if (eval "require $model") {	1359	if (eval "require $model") {
1239	$MODEL = $model;	1360	$MODEL = $model;
1240	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1361	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
		1362	if $VERBOSE >= 7;
1241	} else {	1363	} else {
1242	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1364	AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1243	}	1365	}
1244	}	1366	}
1245		1367
1246	# check for already loaded models	1368	# check for already loaded models
1247	unless ($MODEL) {	1369	unless ($MODEL) {
1248	for (@REGISTRY, @models) {	1370	for (@REGISTRY, @models) {
1249	my ($package, $model) = @$_;	1371	my ($package, $model) = @$_;
1250	if (${"$package\::VERSION"} > 0) {	1372	if (${"$package\::VERSION"} > 0) {
1251	if (eval "require $model") {	1373	if (eval "require $model") {
1252	$MODEL = $model;	1374	$MODEL = $model;
1253	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1375	AnyEvent::log 7 => "autodetected model '$model', using it."
		1376	if $VERBOSE >= 7;
1254	last;	1377	last;
1255	}	1378	}
1256	}	1379	}
1257	}	1380	}
1258		1381
…		…
1265	and eval "require $package"	1388	and eval "require $package"
1266	and ${"$package\::VERSION"} > 0	1389	and ${"$package\::VERSION"} > 0
1267	and eval "require $model"	1390	and eval "require $model"
1268	) {	1391	) {
1269	$MODEL = $model;	1392	$MODEL = $model;
1270	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;	1393	AnyEvent::log 7 => "autoloaded model '$model', using it."
		1394	if $VERBOSE >= 7;
1271	last;	1395	last;
1272	}	1396	}
1273	}	1397	}
1274		1398
1275	$MODEL	1399	$MODEL
1276	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1400	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1277	}	1401	}
1278	}	1402	}
1279		1403
1280	@models = (); # free probe data	1404	# free memory only needed for probing
		1405	undef @models;
		1406	undef @REGISTRY;
1281		1407
1282	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1408	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1283	unshift @ISA, $MODEL;
1284		1409
1285	# now nuke some methods that are overriden by the backend.	1410	# now nuke some methods that are overridden by the backend.
1286	# SUPER is not allowed.	1411	# SUPER usage is not allowed in these.
1287	for (qw(time signal child idle)) {	1412	for (qw(time signal child idle)) {
1288	undef &{"AnyEvent::Base::$_"}	1413	undef &{"AnyEvent::Base::$_"}
1289	if defined &{"$MODEL\::$_"};	1414	if defined &{"$MODEL\::$_"};
1290	}	1415	}
1291		1416
1292	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1417	_isa_set;
		1418
		1419	# we're officially open!
		1420
		1421	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1422	require AnyEvent::Strict;
		1423	}
		1424
		1425	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1426	require AnyEvent::Debug;
		1427	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1428	}
		1429
		1430	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1431	require AnyEvent::Socket;
		1432	require AnyEvent::Debug;
		1433
		1434	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1435	$shell =~ s/\$\$/$$/g;
		1436
		1437	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1438	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1439	}
		1440
		1441	# now the anyevent environment is set up as the user told us to, so
		1442	# call the actual user code - post detects
1293		1443
1294	(shift @post_detect)->() while @post_detect;	1444	(shift @post_detect)->() while @post_detect;
		1445	undef @post_detect;
1295		1446
1296	*post_detect = sub(&) {	1447	*post_detect = sub(&) {
1297	shift->();	1448	shift->();
1298		1449
1299	undef	1450	undef
1300	};	1451	};
1301		1452
1302	$MODEL	1453	$MODEL
1303	}	1454	}
1304		1455
1305	sub AUTOLOAD {	1456	for my $name (@methods) {
1306	(my $func = $AUTOLOAD) =~ s/.*://;	1457	*$name = sub {
1307
1308	$method{$func}
1309	or Carp::croak "$func: not a valid AnyEvent class method";
1310
1311	detect;	1458	detect;
1312		1459	# we use goto because
1313	my $class = shift;	1460	# a) it makes the thunk more transparent
1314	$class->$func (@_);	1461	# b) it allows us to delete the thunk later
		1462	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1463	};
1315	}	1464	}
1316		1465
1317	# utility function to dup a filehandle. this is used by many backends	1466	# utility function to dup a filehandle. this is used by many backends
1318	# to support binding more than one watcher per filehandle (they usually	1467	# to support binding more than one watcher per filehandle (they usually
1319	# allow only one watcher per fd, so we dup it to get a different one).	1468	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1343		1492
1344	package AE;	1493	package AE;
1345		1494
1346	our $VERSION = $AnyEvent::VERSION;	1495	our $VERSION = $AnyEvent::VERSION;
1347		1496
		1497	sub _reset() {
		1498	eval q{
1348	# fall back to the main API by default - backends and AnyEvent::Base	1499	# fall back to the main API by default - backends and AnyEvent::Base
1349	# implementations can overwrite these.	1500	# implementations can overwrite these.
1350		1501
1351	sub io($$$) {	1502	sub io($$$) {
1352	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1503	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1353	}	1504	}
1354		1505
1355	sub timer($$$) {	1506	sub timer($$$) {
1356	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1507	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1357	}	1508	}
1358		1509
1359	sub signal($$) {	1510	sub signal($$) {
1360	AnyEvent->signal (signal => $_[0], cb => $_[1])	1511	AnyEvent->signal (signal => $_[0], cb => $_[1])
1361	}	1512	}
1362		1513
1363	sub child($$) {	1514	sub child($$) {
1364	AnyEvent->child (pid => $_[0], cb => $_[1])	1515	AnyEvent->child (pid => $_[0], cb => $_[1])
1365	}	1516	}
1366		1517
1367	sub idle($) {	1518	sub idle($) {
1368	AnyEvent->idle (cb => $_[0])	1519	AnyEvent->idle (cb => $_[0]);
1369	}	1520	}
1370		1521
1371	sub cv(;&) {	1522	sub cv(;&) {
1372	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1523	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1373	}	1524	}
1374		1525
1375	sub now() {	1526	sub now() {
1376	AnyEvent->now	1527	AnyEvent->now
1377	}	1528	}
1378		1529
1379	sub now_update() {	1530	sub now_update() {
1380	AnyEvent->now_update	1531	AnyEvent->now_update
1381	}	1532	}
1382		1533
1383	sub time() {	1534	sub time() {
1384	AnyEvent->time	1535	AnyEvent->time
		1536	}
		1537
		1538	*postpone = \&AnyEvent::postpone;
		1539	*log = \&AnyEvent::log;
		1540	};
		1541	die if $@;
1385	}	1542	}
		1543
		1544	BEGIN { _reset }
1386		1545
1387	package AnyEvent::Base;	1546	package AnyEvent::Base;
1388		1547
1389	# default implementations for many methods	1548	# default implementations for many methods
1390		1549
1391	sub time {	1550	sub time {
1392	eval q{ # poor man's autoloading {}	1551	eval q{ # poor man's autoloading {}
1393	# probe for availability of Time::HiRes	1552	# probe for availability of Time::HiRes
1394	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1553	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1395	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1554	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
		1555	if $AnyEvent::VERBOSE >= 8;
		1556	*time = sub { Time::HiRes::time () };
1396	*AE::time = \&Time::HiRes::time;	1557	*AE::time = \& Time::HiRes::time ;
1397	# if (eval "use POSIX (); (POSIX::times())...	1558	# if (eval "use POSIX (); (POSIX::times())...
1398	} else {	1559	} else {
1399	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1560	AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
		1561	*time = sub { CORE::time };
1400	*AE::time = sub (){ time }; # epic fail	1562	*AE::time = sub (){ CORE::time };
1401	}	1563	}
1402		1564
1403	*time = sub { AE::time }; # different prototypes	1565	*now = \&time;
1404	};	1566	};
1405	die if $@;	1567	die if $@;
1406		1568
1407	&time	1569	&time
1408	}	1570	}
1409		1571
1410	*now = \&time;	1572	*now = \&time;
1411
1412	sub now_update { }	1573	sub now_update { }
1413		1574
		1575	sub _poll {
		1576	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1577	}
		1578
1414	# default implementation for ->condvar	1579	# default implementation for ->condvar
		1580	# in fact, the default should not be overwritten
1415		1581
1416	sub condvar {	1582	sub condvar {
1417	eval q{ # poor man's autoloading {}	1583	eval q{ # poor man's autoloading {}
1418	*condvar = sub {	1584	*condvar = sub {
1419	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1585	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1497		1663
1498	sub signal {	1664	sub signal {
1499	eval q{ # poor man's autoloading {}	1665	eval q{ # poor man's autoloading {}
1500	# probe for availability of Async::Interrupt	1666	# probe for availability of Async::Interrupt
1501	if (_have_async_interrupt) {	1667	if (_have_async_interrupt) {
1502	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1668	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
		1669	if $AnyEvent::VERBOSE >= 8;
1503		1670
1504	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1671	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1505	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1672	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1506		1673
1507	} else {	1674	} else {
1508	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1675	AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
		1676	if $AnyEvent::VERBOSE >= 8;
1509		1677
1510	if (AnyEvent::WIN32) {	1678	if (AnyEvent::WIN32) {
1511	require AnyEvent::Util;	1679	require AnyEvent::Util;
1512		1680
1513	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1681	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1589	: sysread $SIGPIPE_R, (my $dummy), 9;	1757	: sysread $SIGPIPE_R, (my $dummy), 9;
1590		1758
1591	while (%SIG_EV) {	1759	while (%SIG_EV) {
1592	for (keys %SIG_EV) {	1760	for (keys %SIG_EV) {
1593	delete $SIG_EV{$_};	1761	delete $SIG_EV{$_};
1594	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1762	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1595	}	1763	}
1596	}	1764	}
1597	};	1765	};
1598	};	1766	};
1599	die if $@;	1767	die if $@;
…		…
1604	# default implementation for ->child	1772	# default implementation for ->child
1605		1773
1606	our %PID_CB;	1774	our %PID_CB;
1607	our $CHLD_W;	1775	our $CHLD_W;
1608	our $CHLD_DELAY_W;	1776	our $CHLD_DELAY_W;
1609	our $WNOHANG;
1610		1777
1611	# used by many Impl's	1778	# used by many Impl's
1612	sub _emit_childstatus($$) {	1779	sub _emit_childstatus($$) {
1613	my (undef, $rpid, $rstatus) = @_;	1780	my (undef, $rpid, $rstatus) = @_;
1614		1781
…		…
1621	eval q{ # poor man's autoloading {}	1788	eval q{ # poor man's autoloading {}
1622	*_sigchld = sub {	1789	*_sigchld = sub {
1623	my $pid;	1790	my $pid;
1624		1791
1625	AnyEvent->_emit_childstatus ($pid, $?)	1792	AnyEvent->_emit_childstatus ($pid, $?)
1626	while ($pid = waitpid -1, $WNOHANG) > 0;	1793	while ($pid = waitpid -1, WNOHANG) > 0;
1627	};	1794	};
1628		1795
1629	*child = sub {	1796	*child = sub {
1630	my (undef, %arg) = @_;	1797	my (undef, %arg) = @_;
1631		1798
1632	defined (my $pid = $arg{pid} + 0)	1799	my $pid = $arg{pid};
1633	or Carp::croak "required option 'pid' is missing";	1800	my $cb = $arg{cb};
1634		1801
1635	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1802	$PID_CB{$pid}{$cb+0} = $cb;
1636
1637	# WNOHANG is almost cetrainly 1 everywhere
1638	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1639	? 1
1640	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1641		1803
1642	unless ($CHLD_W) {	1804	unless ($CHLD_W) {
1643	$CHLD_W = AE::signal CHLD => \&_sigchld;	1805	$CHLD_W = AE::signal CHLD => \&_sigchld;
1644	# child could be a zombie already, so make at least one round	1806	# child could be a zombie already, so make at least one round
1645	&_sigchld;	1807	&_sigchld;
1646	}	1808	}
1647		1809
1648	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1810	bless [$pid, $cb+0], "AnyEvent::Base::child"
1649	};	1811	};
1650		1812
1651	*AnyEvent::Base::child::DESTROY = sub {	1813	*AnyEvent::Base::child::DESTROY = sub {
1652	my ($pid, $cb) = @{$_[0]};	1814	my ($pid, $icb) = @{$_[0]};
1653		1815
1654	delete $PID_CB{$pid}{$cb};	1816	delete $PID_CB{$pid}{$icb};
1655	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1817	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1656		1818
1657	undef $CHLD_W unless keys %PID_CB;	1819	undef $CHLD_W unless keys %PID_CB;
1658	};	1820	};
1659	};	1821	};
…		…
1672		1834
1673	my ($cb, $w, $rcb) = $arg{cb};	1835	my ($cb, $w, $rcb) = $arg{cb};
1674		1836
1675	$rcb = sub {	1837	$rcb = sub {
1676	if ($cb) {	1838	if ($cb) {
1677	$w = _time;	1839	$w = AE::time;
1678	&$cb;	1840	&$cb;
1679	$w = _time - $w;	1841	$w = AE::time - $w;
1680		1842
1681	# never use more then 50% of the time for the idle watcher,	1843	# never use more then 50% of the time for the idle watcher,
1682	# within some limits	1844	# within some limits
1683	$w = 0.0001 if $w < 0.0001;	1845	$w = 0.0001 if $w < 0.0001;
1684	$w = 5 if $w > 5;	1846	$w = 5 if $w > 5;
…		…
1707		1869
1708	package AnyEvent::CondVar;	1870	package AnyEvent::CondVar;
1709		1871
1710	our @ISA = AnyEvent::CondVar::Base::;	1872	our @ISA = AnyEvent::CondVar::Base::;
1711		1873
		1874	# only to be used for subclassing
		1875	sub new {
		1876	my $class = shift;
		1877	bless AnyEvent->condvar (@_), $class
		1878	}
		1879
1712	package AnyEvent::CondVar::Base;	1880	package AnyEvent::CondVar::Base;
1713		1881
1714	#use overload	1882	#use overload
1715	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1883	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1716	# fallback => 1;	1884	# fallback => 1;
…		…
1725		1893
1726	sub _send {	1894	sub _send {
1727	# nop	1895	# nop
1728	}	1896	}
1729		1897
		1898	sub _wait {
		1899	AnyEvent->_poll until $_[0]{_ae_sent};
		1900	}
		1901
1730	sub send {	1902	sub send {
1731	my $cv = shift;	1903	my $cv = shift;
1732	$cv->{_ae_sent} = [@_];	1904	$cv->{_ae_sent} = [@_];
1733	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1905	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1734	$cv->_send;	1906	$cv->_send;
…		…
1741		1913
1742	sub ready {	1914	sub ready {
1743	$_[0]{_ae_sent}	1915	$_[0]{_ae_sent}
1744	}	1916	}
1745		1917
1746	sub _wait {
1747	$WAITING
1748	and !$_[0]{_ae_sent}
1749	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1750
1751	local $WAITING = 1;
1752	AnyEvent->one_event while !$_[0]{_ae_sent};
1753	}
1754
1755	sub recv {	1918	sub recv {
		1919	unless ($_[0]{_ae_sent}) {
		1920	$WAITING
		1921	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1922
		1923	local $WAITING = 1;
1756	$_[0]->_wait;	1924	$_[0]->_wait;
		1925	}
1757		1926
1758	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1927	$_[0]{_ae_croak}
1759	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1928	and Carp::croak $_[0]{_ae_croak};
		1929
		1930	wantarray
		1931	? @{ $_[0]{_ae_sent} }
		1932	: $_[0]{_ae_sent}[0]
1760	}	1933	}
1761		1934
1762	sub cb {	1935	sub cb {
1763	my $cv = shift;	1936	my $cv = shift;
1764		1937
…		…
1780	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1953	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1781	}	1954	}
1782		1955
1783	# undocumented/compatibility with pre-3.4	1956	# undocumented/compatibility with pre-3.4
1784	*broadcast = \&send;	1957	*broadcast = \&send;
1785	*wait = \&_wait;	1958	*wait = \&recv;
1786		1959
1787	=head1 ERROR AND EXCEPTION HANDLING	1960	=head1 ERROR AND EXCEPTION HANDLING
1788		1961
1789	In general, AnyEvent does not do any error handling - it relies on the	1962	In general, AnyEvent does not do any error handling - it relies on the
1790	caller to do that if required. The L<AnyEvent::Strict> module (see also	1963	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1817		1990
1818	By default, AnyEvent will be completely silent except in fatal	1991	By default, AnyEvent will be completely silent except in fatal
1819	conditions. You can set this environment variable to make AnyEvent more	1992	conditions. You can set this environment variable to make AnyEvent more
1820	talkative.	1993	talkative.
1821		1994
1822	When set to C<1> or higher, causes AnyEvent to warn about unexpected	1995	When set to C<5> or higher, causes AnyEvent to warn about unexpected
1823	conditions, such as not being able to load the event model specified by	1996	conditions, such as not being able to load the event model specified by
1824	C<PERL_ANYEVENT_MODEL>.	1997	C<PERL_ANYEVENT_MODEL>.
1825		1998
1826	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1999	When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1827	model it chooses.	2000	model it chooses.
1828		2001
1829	When set to C<8> or higher, then AnyEvent will report extra information on	2002	When set to C<8> or higher, then AnyEvent will report extra information on
1830	which optional modules it loads and how it implements certain features.	2003	which optional modules it loads and how it implements certain features.
1831		2004
…		…
1837	check the arguments passed to most method calls. If it finds any problems,	2010	check the arguments passed to most method calls. If it finds any problems,
1838	it will croak.	2011	it will croak.
1839		2012
1840	In other words, enables "strict" mode.	2013	In other words, enables "strict" mode.
1841		2014
1842	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	2015	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1843	>>, it is definitely recommended to keep it off in production. Keeping	2016	>>, it is definitely recommended to keep it off in production. Keeping
1844	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2017	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1845	can be very useful, however.	2018	can be very useful, however.
1846		2019
		2020	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2021
		2022	If this env variable is set, then its contents will be interpreted by
		2023	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2024	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2025	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2026
		2027	This takes place when the first watcher is created.
		2028
		2029	For example, to bind a debug shell on a unix domain socket in
		2030	F<< /tmp/debug<pid>.sock >>, you could use this:
		2031
		2032	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2033
		2034	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2035	systems.
		2036
		2037	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2038
		2039	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2040	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2041
1847	=item C<PERL_ANYEVENT_MODEL>	2042	=item C<PERL_ANYEVENT_MODEL>
1848		2043
1849	This can be used to specify the event model to be used by AnyEvent, before	2044	This can be used to specify the event model to be used by AnyEvent, before
1850	auto detection and -probing kicks in. It must be a string consisting	2045	auto detection and -probing kicks in.
1851	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2046
		2047	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2048	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1852	and the resulting module name is loaded and if the load was successful,	2049	resulting module name is loaded and - if the load was successful - used as
1853	used as event model. If it fails to load AnyEvent will proceed with	2050	event model backend. If it fails to load then AnyEvent will proceed with
1854	auto detection and -probing.	2051	auto detection and -probing.
1855		2052
1856	This functionality might change in future versions.	2053	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2054	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2055	the end of a string designates a module name and quotes it appropriately).
1857		2056
1858	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2057	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1859	could start your program like this:	2058	could start your program like this:
1860		2059
1861	PERL_ANYEVENT_MODEL=Perl perl ...	2060	PERL_ANYEVENT_MODEL=Perl perl ...
1862		2061
1863	=item C<PERL_ANYEVENT_PROTOCOLS>	2062	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
2253	(even when used without AnyEvent), but most event loops have acceptable	2452	(even when used without AnyEvent), but most event loops have acceptable
2254	performance with or without AnyEvent.	2453	performance with or without AnyEvent.
2255		2454
2256	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2455	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2257	the actual event loop, only with extremely fast event loops such as EV	2456	the actual event loop, only with extremely fast event loops such as EV
2258	adds AnyEvent significant overhead.	2457	does AnyEvent add significant overhead.
2259		2458
2260	=item * You should avoid POE like the plague if you want performance or	2459	=item * You should avoid POE like the plague if you want performance or
2261	reasonable memory usage.	2460	reasonable memory usage.
2262		2461
2263	=back	2462	=back
…		…
2493	unless defined $SIG{PIPE};	2692	unless defined $SIG{PIPE};
2494		2693
2495	=head1 RECOMMENDED/OPTIONAL MODULES	2694	=head1 RECOMMENDED/OPTIONAL MODULES
2496		2695
2497	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2696	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2498	it's built-in modules) are required to use it.	2697	its built-in modules) are required to use it.
2499		2698
2500	That does not mean that AnyEvent won't take advantage of some additional	2699	That does not mean that AnyEvent won't take advantage of some additional
2501	modules if they are installed.	2700	modules if they are installed.
2502		2701
2503	This section explains which additional modules will be used, and how they	2702	This section explains which additional modules will be used, and how they
…		…
2561	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2760	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2562		2761
2563	=item L<Time::HiRes>	2762	=item L<Time::HiRes>
2564		2763
2565	This module is part of perl since release 5.008. It will be used when the	2764	This module is part of perl since release 5.008. It will be used when the
2566	chosen event library does not come with a timing source on it's own. The	2765	chosen event library does not come with a timing source of its own. The
2567	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2766	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2568	try to use a monotonic clock for timing stability.	2767	try to use a monotonic clock for timing stability.
2569		2768
2570	=back	2769	=back
2571		2770
2572		2771
…		…
2634	pronounced).	2833	pronounced).
2635		2834
2636		2835
2637	=head1 SEE ALSO	2836	=head1 SEE ALSO
2638		2837
2639	Utility functions: L<AnyEvent::Util>.	2838	Tutorial/Introduction: L<AnyEvent::Intro>.
2640		2839
2641	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2840	FAQ: L<AnyEvent::FAQ>.
2642	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2841
		2842	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2843	(simply logging).
		2844
		2845	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2846	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2847
		2848	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2849	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2850	L<Qt>, L<POE>, L<FLTK>.
2643		2851
2644	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2852	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2645	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2853	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2646	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2854	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2647	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2855	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2856	L<AnyEvent::Impl::FLTK>.
2648		2857
2649	Non-blocking file handles, sockets, TCP clients and	2858	Non-blocking handles, pipes, stream sockets, TCP clients and
2650	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2859	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2651		2860
2652	Asynchronous DNS: L<AnyEvent::DNS>.	2861	Asynchronous DNS: L<AnyEvent::DNS>.
2653		2862
2654	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2863	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2655	L<Coro::Event>,
2656		2864
2657	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2865	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2658	L<AnyEvent::HTTP>.	2866	L<AnyEvent::HTTP>.
2659		2867
2660		2868
2661	=head1 AUTHOR	2869	=head1 AUTHOR
2662		2870

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.323 by root, Thu May 20 21:22:20 2010 UTC vs. Revision 1.369 by root, Wed Aug 17 02:32:01 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.323 by root, Thu May 20 21:22:20 2010 UTC vs.
Revision 1.369 by root, Wed Aug 17 02:32:01 2011 UTC