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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.297 by root, Thu Nov 19 01:55:57 2009 UTC vs.
Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC

…		…
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18		21
19	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21		24
22	# POSIX signal	25	# POSIX signal
…		…
73	module users into the same thing by forcing them to use the same event	76	module users into the same thing by forcing them to use the same event
74	model you use.	77	model you use.
75		78
76	For modules like POE or IO::Async (which is a total misnomer as it is	79	For modules like POE or IO::Async (which is a total misnomer as it is
77	actually doing all I/O I<synchronously>...), using them in your module is	80	actually doing all I/O I<synchronously>...), using them in your module is
78	like joining a cult: After you joined, you are dependent on them and you	81	like joining a cult: After you join, you are dependent on them and you
79	cannot use anything else, as they are simply incompatible to everything	82	cannot use anything else, as they are simply incompatible to everything
80	that isn't them. What's worse, all the potential users of your	83	that isn't them. What's worse, all the potential users of your
81	module are I<also> forced to use the same event loop you use.	84	module are I<also> forced to use the same event loop you use.
82		85
83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	86	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	87	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
85	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	88	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
86	your module uses one of those, every user of your module has to use it,	89	your module uses one of those, every user of your module has to use it,
87	too. But if your module uses AnyEvent, it works transparently with all	90	too. But if your module uses AnyEvent, it works transparently with all
88	event models it supports (including stuff like IO::Async, as long as those	91	event models it supports (including stuff like IO::Async, as long as those
89	use one of the supported event loops. It is trivial to add new event loops	92	use one of the supported event loops. It is easy to add new event loops
90	to AnyEvent, too, so it is future-proof).	93	to AnyEvent, too, so it is future-proof).
91		94
92	In addition to being free of having to use I<the one and only true event	95	In addition to being free of having to use I<the one and only true event
93	model>, AnyEvent also is free of bloat and policy: with POE or similar	96	model>, AnyEvent also is free of bloat and policy: with POE or similar
94	modules, you get an enormous amount of code and strict rules you have to	97	modules, you get an enormous amount of code and strict rules you have to
95	follow. AnyEvent, on the other hand, is lean and up to the point, by only	98	follow. AnyEvent, on the other hand, is lean and to the point, by only
96	offering the functionality that is necessary, in as thin as a wrapper as	99	offering the functionality that is necessary, in as thin as a wrapper as
97	technically possible.	100	technically possible.
98		101
99	Of course, AnyEvent comes with a big (and fully optional!) toolbox	102	Of course, AnyEvent comes with a big (and fully optional!) toolbox
100	of useful functionality, such as an asynchronous DNS resolver, 100%	103	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
106	useful) and you want to force your users to use the one and only event	109	useful) and you want to force your users to use the one and only event
107	model, you should I<not> use this module.	110	model, you should I<not> use this module.
108		111
109	=head1 DESCRIPTION	112	=head1 DESCRIPTION
110		113
111	L<AnyEvent> provides an identical interface to multiple event loops. This	114	L<AnyEvent> provides a uniform interface to various event loops. This
112	allows module authors to utilise an event loop without forcing module	115	allows module authors to use event loop functionality without forcing
113	users to use the same event loop (as only a single event loop can coexist	116	module users to use a specific event loop implementation (since more
114	peacefully at any one time).	117	than one event loop cannot coexist peacefully).
115		118
116	The interface itself is vaguely similar, but not identical to the L<Event>	119	The interface itself is vaguely similar, but not identical to the L<Event>
117	module.	120	module.
118		121
119	During the first call of any watcher-creation method, the module tries	122	During the first call of any watcher-creation method, the module tries
120	to detect the currently loaded event loop by probing whether one of the	123	to detect the currently loaded event loop by probing whether one of the
121	following modules is already loaded: L<EV>,	124	following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,
122	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	125	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
123	L<POE>. The first one found is used. If none are found, the module tries	126	found is used. If none are detected, the module tries to load the first
124	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	127	four modules in the order given; but note that if L<EV> is not
125	adaptor should always succeed) in the order given. The first one that can	128	available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so
126	be successfully loaded will be used. If, after this, still none could be	129	the other two are not normally tried.
127	found, AnyEvent will fall back to a pure-perl event loop, which is not
128	very efficient, but should work everywhere.
129		130
130	Because AnyEvent first checks for modules that are already loaded, loading	131	Because AnyEvent first checks for modules that are already loaded, loading
131	an event model explicitly before first using AnyEvent will likely make	132	an event model explicitly before first using AnyEvent will likely make
132	that model the default. For example:	133	that model the default. For example:
133		134
…		…
135	use AnyEvent;	136	use AnyEvent;
136		137
137	# .. AnyEvent will likely default to Tk	138	# .. AnyEvent will likely default to Tk
138		139
139	The I<likely> means that, if any module loads another event model and	140	The I<likely> means that, if any module loads another event model and
140	starts using it, all bets are off. Maybe you should tell their authors to	141	starts using it, all bets are off - this case should be very rare though,
141	use AnyEvent so their modules work together with others seamlessly...	142	as very few modules hardcode event loops without announcing this very
		143	loudly.
142		144
143	The pure-perl implementation of AnyEvent is called	145	The pure-perl implementation of AnyEvent is called
144	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	146	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
145	explicitly and enjoy the high availability of that event loop :)	147	explicitly and enjoy the high availability of that event loop :)
146		148
…		…
155	callback when the event occurs (of course, only when the event model	157	callback when the event occurs (of course, only when the event model
156	is in control).	158	is in control).
157		159
158	Note that B<callbacks must not permanently change global variables>	160	Note that B<callbacks must not permanently change global variables>
159	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<	161	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
160	callbacks must not C<die> >>. The former is good programming practise in	162	callbacks must not C<die> >>. The former is good programming practice in
161	Perl and the latter stems from the fact that exception handling differs	163	Perl and the latter stems from the fact that exception handling differs
162	widely between event loops.	164	widely between event loops.
163		165
164	To disable the watcher you have to destroy it (e.g. by setting the	166	To disable a watcher you have to destroy it (e.g. by setting the
165	variable you store it in to C<undef> or otherwise deleting all references	167	variable you store it in to C<undef> or otherwise deleting all references
166	to it).	168	to it).
167		169
168	All watchers are created by calling a method on the C<AnyEvent> class.	170	All watchers are created by calling a method on the C<AnyEvent> class.
169		171
170	Many watchers either are used with "recursion" (repeating timers for	172	Many watchers either are used with "recursion" (repeating timers for
171	example), or need to refer to their watcher object in other ways.	173	example), or need to refer to their watcher object in other ways.
172		174
173	An any way to achieve that is this pattern:	175	One way to achieve that is this pattern:
174		176
175	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	177	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
176	# you can use $w here, for example to undef it	178	# you can use $w here, for example to undef it
177	undef $w;	179	undef $w;
178	});	180	});
…		…
210		212
211	The I/O watcher might use the underlying file descriptor or a copy of it.	213	The I/O watcher might use the underlying file descriptor or a copy of it.
212	You must not close a file handle as long as any watcher is active on the	214	You must not close a file handle as long as any watcher is active on the
213	underlying file descriptor.	215	underlying file descriptor.
214		216
215	Some event loops issue spurious readyness notifications, so you should	217	Some event loops issue spurious readiness notifications, so you should
216	always use non-blocking calls when reading/writing from/to your file	218	always use non-blocking calls when reading/writing from/to your file
217	handles.	219	handles.
218		220
219	Example: wait for readability of STDIN, then read a line and disable the	221	Example: wait for readability of STDIN, then read a line and disable the
220	watcher.	222	watcher.
…		…
244		246
245	Although the callback might get passed parameters, their value and	247	Although the callback might get passed parameters, their value and
246	presence is undefined and you cannot rely on them. Portable AnyEvent	248	presence is undefined and you cannot rely on them. Portable AnyEvent
247	callbacks cannot use arguments passed to time watcher callbacks.	249	callbacks cannot use arguments passed to time watcher callbacks.
248		250
249	The callback will normally be invoked once only. If you specify another	251	The callback will normally be invoked only once. If you specify another
250	parameter, C<interval>, as a strictly positive number (> 0), then the	252	parameter, C<interval>, as a strictly positive number (> 0), then the
251	callback will be invoked regularly at that interval (in fractional	253	callback will be invoked regularly at that interval (in fractional
252	seconds) after the first invocation. If C<interval> is specified with a	254	seconds) after the first invocation. If C<interval> is specified with a
253	false value, then it is treated as if it were missing.	255	false value, then it is treated as if it were not specified at all.
254		256
255	The callback will be rescheduled before invoking the callback, but no	257	The callback will be rescheduled before invoking the callback, but no
256	attempt is done to avoid timer drift in most backends, so the interval is	258	attempt is made to avoid timer drift in most backends, so the interval is
257	only approximate.	259	only approximate.
258		260
259	Example: fire an event after 7.7 seconds.	261	Example: fire an event after 7.7 seconds.
260		262
261	my $w = AnyEvent->timer (after => 7.7, cb => sub {	263	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
279		281
280	While most event loops expect timers to specified in a relative way, they	282	While most event loops expect timers to specified in a relative way, they
281	use absolute time internally. This makes a difference when your clock	283	use absolute time internally. This makes a difference when your clock
282	"jumps", for example, when ntp decides to set your clock backwards from	284	"jumps", for example, when ntp decides to set your clock backwards from
283	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to	285	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
284	fire "after" a second might actually take six years to finally fire.	286	fire "after a second" might actually take six years to finally fire.
285		287
286	AnyEvent cannot compensate for this. The only event loop that is conscious	288	AnyEvent cannot compensate for this. The only event loop that is conscious
287	about these issues is L<EV>, which offers both relative (ev_timer, based	289	of these issues is L<EV>, which offers both relative (ev_timer, based
288	on true relative time) and absolute (ev_periodic, based on wallclock time)	290	on true relative time) and absolute (ev_periodic, based on wallclock time)
289	timers.	291	timers.
290		292
291	AnyEvent always prefers relative timers, if available, matching the	293	AnyEvent always prefers relative timers, if available, matching the
292	AnyEvent API.	294	AnyEvent API.
…		…
314	I<In almost all cases (in all cases if you don't care), this is the	316	I<In almost all cases (in all cases if you don't care), this is the
315	function to call when you want to know the current time.>	317	function to call when you want to know the current time.>
316		318
317	This function is also often faster then C<< AnyEvent->time >>, and	319	This function is also often faster then C<< AnyEvent->time >>, and
318	thus the preferred method if you want some timestamp (for example,	320	thus the preferred method if you want some timestamp (for example,
319	L<AnyEvent::Handle> uses this to update it's activity timeouts).	321	L<AnyEvent::Handle> uses this to update its activity timeouts).
320		322
321	The rest of this section is only of relevance if you try to be very exact	323	The rest of this section is only of relevance if you try to be very exact
322	with your timing, you can skip it without bad conscience.	324	with your timing; you can skip it without a bad conscience.
323		325
324	For a practical example of when these times differ, consider L<Event::Lib>	326	For a practical example of when these times differ, consider L<Event::Lib>
325	and L<EV> and the following set-up:	327	and L<EV> and the following set-up:
326		328
327	The event loop is running and has just invoked one of your callback at	329	The event loop is running and has just invoked one of your callbacks at
328	time=500 (assume no other callbacks delay processing). In your callback,	330	time=500 (assume no other callbacks delay processing). In your callback,
329	you wait a second by executing C<sleep 1> (blocking the process for a	331	you wait a second by executing C<sleep 1> (blocking the process for a
330	second) and then (at time=501) you create a relative timer that fires	332	second) and then (at time=501) you create a relative timer that fires
331	after three seconds.	333	after three seconds.
332		334
…		…
403		405
404	Example: exit on SIGINT	406	Example: exit on SIGINT
405		407
406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	408	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
407		409
		410	=head3 Restart Behaviour
		411
		412	While restart behaviour is up to the event loop implementation, most will
		413	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		414	pure perl implementation).
		415
		416	=head3 Safe/Unsafe Signals
		417
		418	Perl signals can be either "safe" (synchronous to opcode handling) or
		419	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		420	latter might corrupt your memory.
		421
		422	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		423	i.e. they will not interrupt your running perl program but will only be
		424	called as part of the normal event handling (just like timer, I/O etc.
		425	callbacks, too).
		426
408	=head3 Signal Races, Delays and Workarounds	427	=head3 Signal Races, Delays and Workarounds
409		428
410	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	429	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
411	callbacks to signals in a generic way, which is a pity, as you cannot	430	callbacks to signals in a generic way, which is a pity, as you cannot
412	do race-free signal handling in perl, requiring C libraries for	431	do race-free signal handling in perl, requiring C libraries for
413	this. AnyEvent will try to do it's best, which means in some cases,	432	this. AnyEvent will try to do its best, which means in some cases,
414	signals will be delayed. The maximum time a signal might be delayed is	433	signals will be delayed. The maximum time a signal might be delayed is
415	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	434	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
416	variable can be changed only before the first signal watcher is created,	435	variable can be changed only before the first signal watcher is created,
417	and should be left alone otherwise. This variable determines how often	436	and should be left alone otherwise. This variable determines how often
418	AnyEvent polls for signals (in case a wake-up was missed). Higher values	437	AnyEvent polls for signals (in case a wake-up was missed). Higher values
…		…
420	saving.	439	saving.
421		440
422	All these problems can be avoided by installing the optional	441	All these problems can be avoided by installing the optional
423	L<Async::Interrupt> module, which works with most event loops. It will not	442	L<Async::Interrupt> module, which works with most event loops. It will not
424	work with inherently broken event loops such as L<Event> or L<Event::Lib>	443	work with inherently broken event loops such as L<Event> or L<Event::Lib>
425	(and not with L<POE> currently, as POE does it's own workaround with	444	(and not with L<POE> currently, as POE does its own workaround with
426	one-second latency). For those, you just have to suffer the delays.	445	one-second latency). For those, you just have to suffer the delays.
427		446
428	=head2 CHILD PROCESS WATCHERS	447	=head2 CHILD PROCESS WATCHERS
429		448
430	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	449	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
431		450
432	You can also watch on a child process exit and catch its exit status.	451	You can also watch for a child process exit and catch its exit status.
433		452
434	The child process is specified by the C<pid> argument (one some backends,	453	The child process is specified by the C<pid> argument (on some backends,
435	using C<0> watches for any child process exit, on others this will	454	using C<0> watches for any child process exit, on others this will
436	croak). The watcher will be triggered only when the child process has	455	croak). The watcher will be triggered only when the child process has
437	finished and an exit status is available, not on any trace events	456	finished and an exit status is available, not on any trace events
438	(stopped/continued).	457	(stopped/continued).
439		458
…		…
486		505
487	=head2 IDLE WATCHERS	506	=head2 IDLE WATCHERS
488		507
489	$w = AnyEvent->idle (cb => <callback>);	508	$w = AnyEvent->idle (cb => <callback>);
490		509
491	Sometimes there is a need to do something, but it is not so important	510	This will repeatedly invoke the callback after the process becomes idle,
492	to do it instantly, but only when there is nothing better to do. This	511	until either the watcher is destroyed or new events have been detected.
493	"nothing better to do" is usually defined to be "no other events need
494	attention by the event loop".
495		512
496	Idle watchers ideally get invoked when the event loop has nothing	513	Idle watchers are useful when there is a need to do something, but it
497	better to do, just before it would block the process to wait for new	514	is not so important (or wise) to do it instantly. The callback will be
498	events. Instead of blocking, the idle watcher is invoked.	515	invoked only when there is "nothing better to do", which is usually
		516	defined as "all outstanding events have been handled and no new events
		517	have been detected". That means that idle watchers ideally get invoked
		518	when the event loop has just polled for new events but none have been
		519	detected. Instead of blocking to wait for more events, the idle watchers
		520	will be invoked.
499		521
500	Most event loops unfortunately do not really support idle watchers (only	522	Unfortunately, most event loops do not really support idle watchers (only
501	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	523	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
502	will simply call the callback "from time to time".	524	will simply call the callback "from time to time".
503		525
504	Example: read lines from STDIN, but only process them when the	526	Example: read lines from STDIN, but only process them when the
505	program is otherwise idle:	527	program is otherwise idle:
…		…
533	will actively watch for new events and call your callbacks.	555	will actively watch for new events and call your callbacks.
534		556
535	AnyEvent is slightly different: it expects somebody else to run the event	557	AnyEvent is slightly different: it expects somebody else to run the event
536	loop and will only block when necessary (usually when told by the user).	558	loop and will only block when necessary (usually when told by the user).
537		559
538	The instrument to do that is called a "condition variable", so called	560	The tool to do that is called a "condition variable", so called because
539	because they represent a condition that must become true.	561	they represent a condition that must become true.
540		562
541	Now is probably a good time to look at the examples further below.	563	Now is probably a good time to look at the examples further below.
542		564
543	Condition variables can be created by calling the C<< AnyEvent->condvar	565	Condition variables can be created by calling the C<< AnyEvent->condvar
544	>> method, usually without arguments. The only argument pair allowed is	566	>> method, usually without arguments. The only argument pair allowed is
…		…
549	After creation, the condition variable is "false" until it becomes "true"	571	After creation, the condition variable is "false" until it becomes "true"
550	by calling the C<send> method (or calling the condition variable as if it	572	by calling the C<send> method (or calling the condition variable as if it
551	were a callback, read about the caveats in the description for the C<<	573	were a callback, read about the caveats in the description for the C<<
552	->send >> method).	574	->send >> method).
553		575
554	Condition variables are similar to callbacks, except that you can	576	Since condition variables are the most complex part of the AnyEvent API, here are
555	optionally wait for them. They can also be called merge points - points	577	some different mental models of what they are - pick the ones you can connect to:
556	in time where multiple outstanding events have been processed. And yet	578
557	another way to call them is transactions - each condition variable can be	579	=over 4
558	used to represent a transaction, which finishes at some point and delivers	580
559	a result. And yet some people know them as "futures" - a promise to	581	=item * Condition variables are like callbacks - you can call them (and pass them instead
560	compute/deliver something that you can wait for.	582	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		583
		584	=item * Condition variables are signals - one side can emit or send them,
		585	the other side can wait for them, or install a handler that is called when
		586	the signal fires.
		587
		588	=item * Condition variables are like "Merge Points" - points in your program
		589	where you merge multiple independent results/control flows into one.
		590
		591	=item * Condition variables represent a transaction - functions that start
		592	some kind of transaction can return them, leaving the caller the choice
		593	between waiting in a blocking fashion, or setting a callback.
		594
		595	=item * Condition variables represent future values, or promises to deliver
		596	some result, long before the result is available.
		597
		598	=back
561		599
562	Condition variables are very useful to signal that something has finished,	600	Condition variables are very useful to signal that something has finished,
563	for example, if you write a module that does asynchronous http requests,	601	for example, if you write a module that does asynchronous http requests,
564	then a condition variable would be the ideal candidate to signal the	602	then a condition variable would be the ideal candidate to signal the
565	availability of results. The user can either act when the callback is	603	availability of results. The user can either act when the callback is
…		…
578		616
579	Condition variables are represented by hash refs in perl, and the keys	617	Condition variables are represented by hash refs in perl, and the keys
580	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing	618	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
581	easy (it is often useful to build your own transaction class on top of	619	easy (it is often useful to build your own transaction class on top of
582	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call	620	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
583	it's C<new> method in your own C<new> method.	621	its C<new> method in your own C<new> method.
584		622
585	There are two "sides" to a condition variable - the "producer side" which	623	There are two "sides" to a condition variable - the "producer side" which
586	eventually calls C<< -> send >>, and the "consumer side", which waits	624	eventually calls C<< -> send >>, and the "consumer side", which waits
587	for the send to occur.	625	for the send to occur.
588		626
589	Example: wait for a timer.	627	Example: wait for a timer.
590		628
591	# wait till the result is ready	629	# condition: "wait till the timer is fired"
592	my $result_ready = AnyEvent->condvar;	630	my $timer_fired = AnyEvent->condvar;
593		631
594	# do something such as adding a timer	632	# create the timer - we could wait for, say
595	# or socket watcher the calls $result_ready->send	633	# a handle becomign ready, or even an
596	# when the "result" is ready.	634	# AnyEvent::HTTP request to finish, but
597	# in this case, we simply use a timer:	635	# in this case, we simply use a timer:
598	my $w = AnyEvent->timer (	636	my $w = AnyEvent->timer (
599	after => 1,	637	after => 1,
600	cb => sub { $result_ready->send },	638	cb => sub { $timer_fired->send },
601	);	639	);
602		640
603	# this "blocks" (while handling events) till the callback	641	# this "blocks" (while handling events) till the callback
604	# calls ->send	642	# calls ->send
605	$result_ready->recv;	643	$timer_fired->recv;
606		644
607	Example: wait for a timer, but take advantage of the fact that condition	645	Example: wait for a timer, but take advantage of the fact that condition
608	variables are also callable directly.	646	variables are also callable directly.
609		647
610	my $done = AnyEvent->condvar;	648	my $done = AnyEvent->condvar;
…		…
653	they were a code reference). Calling them directly is the same as calling	691	they were a code reference). Calling them directly is the same as calling
654	C<send>.	692	C<send>.
655		693
656	=item $cv->croak ($error)	694	=item $cv->croak ($error)
657		695
658	Similar to send, but causes all call's to C<< ->recv >> to invoke	696	Similar to send, but causes all calls to C<< ->recv >> to invoke
659	C<Carp::croak> with the given error message/object/scalar.	697	C<Carp::croak> with the given error message/object/scalar.
660		698
661	This can be used to signal any errors to the condition variable	699	This can be used to signal any errors to the condition variable
662	user/consumer. Doing it this way instead of calling C<croak> directly	700	user/consumer. Doing it this way instead of calling C<croak> directly
663	delays the error detetcion, but has the overwhelmign advantage that it	701	delays the error detection, but has the overwhelming advantage that it
664	diagnoses the error at the place where the result is expected, and not	702	diagnoses the error at the place where the result is expected, and not
665	deep in some event clalback without connection to the actual code causing	703	deep in some event callback with no connection to the actual code causing
666	the problem.	704	the problem.
667		705
668	=item $cv->begin ([group callback])	706	=item $cv->begin ([group callback])
669		707
670	=item $cv->end	708	=item $cv->end
…		…
708	one call to C<begin>, so the condvar waits for all calls to C<end> before	746	one call to C<begin>, so the condvar waits for all calls to C<end> before
709	sending.	747	sending.
710		748
711	The ping example mentioned above is slightly more complicated, as the	749	The ping example mentioned above is slightly more complicated, as the
712	there are results to be passwd back, and the number of tasks that are	750	there are results to be passwd back, and the number of tasks that are
713	begung can potentially be zero:	751	begun can potentially be zero:
714		752
715	my $cv = AnyEvent->condvar;	753	my $cv = AnyEvent->condvar;
716		754
717	my %result;	755	my %result;
718	$cv->begin (sub { shift->send (\%result) });	756	$cv->begin (sub { shift->send (\%result) });
…		…
739	to be called once the counter reaches C<0>, and second, it ensures that	777	to be called once the counter reaches C<0>, and second, it ensures that
740	C<send> is called even when C<no> hosts are being pinged (the loop	778	C<send> is called even when C<no> hosts are being pinged (the loop
741	doesn't execute once).	779	doesn't execute once).
742		780
743	This is the general pattern when you "fan out" into multiple (but	781	This is the general pattern when you "fan out" into multiple (but
744	potentially none) subrequests: use an outer C<begin>/C<end> pair to set	782	potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
745	the callback and ensure C<end> is called at least once, and then, for each	783	the callback and ensure C<end> is called at least once, and then, for each
746	subrequest you start, call C<begin> and for each subrequest you finish,	784	subrequest you start, call C<begin> and for each subrequest you finish,
747	call C<end>.	785	call C<end>.
748		786
749	=back	787	=back
…		…
756	=over 4	794	=over 4
757		795
758	=item $cv->recv	796	=item $cv->recv
759		797
760	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	798	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
761	>> methods have been called on c<$cv>, while servicing other watchers	799	>> methods have been called on C<$cv>, while servicing other watchers
762	normally.	800	normally.
763		801
764	You can only wait once on a condition - additional calls are valid but	802	You can only wait once on a condition - additional calls are valid but
765	will return immediately.	803	will return immediately.
766		804
…		…
783	caller decide whether the call will block or not (for example, by coupling	821	caller decide whether the call will block or not (for example, by coupling
784	condition variables with some kind of request results and supporting	822	condition variables with some kind of request results and supporting
785	callbacks so the caller knows that getting the result will not block,	823	callbacks so the caller knows that getting the result will not block,
786	while still supporting blocking waits if the caller so desires).	824	while still supporting blocking waits if the caller so desires).
787		825
788	You can ensure that C<< -recv >> never blocks by setting a callback and	826	You can ensure that C<< ->recv >> never blocks by setting a callback and
789	only calling C<< ->recv >> from within that callback (or at a later	827	only calling C<< ->recv >> from within that callback (or at a later
790	time). This will work even when the event loop does not support blocking	828	time). This will work even when the event loop does not support blocking
791	waits otherwise.	829	waits otherwise.
792		830
793	=item $bool = $cv->ready	831	=item $bool = $cv->ready
…		…
798	=item $cb = $cv->cb ($cb->($cv))	836	=item $cb = $cv->cb ($cb->($cv))
799		837
800	This is a mutator function that returns the callback set and optionally	838	This is a mutator function that returns the callback set and optionally
801	replaces it before doing so.	839	replaces it before doing so.
802		840
803	The callback will be called when the condition becomes (or already was)	841	The callback will be called when the condition becomes "true", i.e. when
804	"true", i.e. when C<send> or C<croak> are called (or were called), with	842	C<send> or C<croak> are called, with the only argument being the
805	the only argument being the condition variable itself. Calling C<recv>	843	condition variable itself. If the condition is already true, the
		844	callback is called immediately when it is set. Calling C<recv> inside
806	inside the callback or at any later time is guaranteed not to block.	845	the callback or at any later time is guaranteed not to block.
807		846
808	=back	847	=back
809		848
810	=head1 SUPPORTED EVENT LOOPS/BACKENDS	849	=head1 SUPPORTED EVENT LOOPS/BACKENDS
811		850
…		…
823	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
824	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	863	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
825		864
826	=item Backends that are transparently being picked up when they are used.	865	=item Backends that are transparently being picked up when they are used.
827		866
828	These will be used when they are currently loaded when the first watcher	867	These will be used if they are already loaded when the first watcher
829	is created, in which case it is assumed that the application is using	868	is created, in which case it is assumed that the application is using
830	them. This means that AnyEvent will automatically pick the right backend	869	them. This means that AnyEvent will automatically pick the right backend
831	when the main program loads an event module before anything starts to	870	when the main program loads an event module before anything starts to
832	create watchers. Nothing special needs to be done by the main program.	871	create watchers. Nothing special needs to be done by the main program.
833		872
…		…
849		888
850	Support for IO::Async can only be partial, as it is too broken and	889	Support for IO::Async can only be partial, as it is too broken and
851	architecturally limited to even support the AnyEvent API. It also	890	architecturally limited to even support the AnyEvent API. It also
852	is the only event loop that needs the loop to be set explicitly, so	891	is the only event loop that needs the loop to be set explicitly, so
853	it can only be used by a main program knowing about AnyEvent. See	892	it can only be used by a main program knowing about AnyEvent. See
854	L<AnyEvent::Impl::Async> for the gory details.	893	L<AnyEvent::Impl::IOAsync> for the gory details.
855		894
856	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.	895	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
857		896
858	=item Event loops that are indirectly supported via other backends.	897	=item Event loops that are indirectly supported via other backends.
859		898
…		…
887	Contains C<undef> until the first watcher is being created, before the	926	Contains C<undef> until the first watcher is being created, before the
888	backend has been autodetected.	927	backend has been autodetected.
889		928
890	Afterwards it contains the event model that is being used, which is the	929	Afterwards it contains the event model that is being used, which is the
891	name of the Perl class implementing the model. This class is usually one	930	name of the Perl class implementing the model. This class is usually one
892	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the	931	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
893	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it	932	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
894	will be C<urxvt::anyevent>).	933	will be C<urxvt::anyevent>).
895		934
896	=item AnyEvent::detect	935	=item AnyEvent::detect
897		936
898	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	937	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
899	if necessary. You should only call this function right before you would	938	if necessary. You should only call this function right before you would
900	have created an AnyEvent watcher anyway, that is, as late as possible at	939	have created an AnyEvent watcher anyway, that is, as late as possible at
901	runtime, and not e.g. while initialising of your module.	940	runtime, and not e.g. during initialisation of your module.
902		941
903	If you need to do some initialisation before AnyEvent watchers are	942	If you need to do some initialisation before AnyEvent watchers are
904	created, use C<post_detect>.	943	created, use C<post_detect>.
905		944
906	=item $guard = AnyEvent::post_detect { BLOCK }	945	=item $guard = AnyEvent::post_detect { BLOCK }
907		946
908	Arranges for the code block to be executed as soon as the event model is	947	Arranges for the code block to be executed as soon as the event model is
909	autodetected (or immediately if this has already happened).	948	autodetected (or immediately if that has already happened).
910		949
911	The block will be executed I<after> the actual backend has been detected	950	The block will be executed I<after> the actual backend has been detected
912	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been	951	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
913	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do	952	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
914	other initialisations - see the sources of L<AnyEvent::Strict> or	953	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
923	that automatically removes the callback again when it is destroyed (or	962	that automatically removes the callback again when it is destroyed (or
924	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for	963	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
925	a case where this is useful.	964	a case where this is useful.
926		965
927	Example: Create a watcher for the IO::AIO module and store it in	966	Example: Create a watcher for the IO::AIO module and store it in
928	C<$WATCHER>. Only do so after the event loop is initialised, though.	967	C<$WATCHER>, but do so only do so after the event loop is initialised.
929		968
930	our WATCHER;	969	our WATCHER;
931		970
932	my $guard = AnyEvent::post_detect {	971	my $guard = AnyEvent::post_detect {
933	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	972	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
941	$WATCHER \|\|= $guard;	980	$WATCHER \|\|= $guard;
942		981
943	=item @AnyEvent::post_detect	982	=item @AnyEvent::post_detect
944		983
945	If there are any code references in this array (you can C<push> to it	984	If there are any code references in this array (you can C<push> to it
946	before or after loading AnyEvent), then they will called directly after	985	before or after loading AnyEvent), then they will be called directly
947	the event loop has been chosen.	986	after the event loop has been chosen.
948		987
949	You should check C<$AnyEvent::MODEL> before adding to this array, though:	988	You should check C<$AnyEvent::MODEL> before adding to this array, though:
950	if it is defined then the event loop has already been detected, and the	989	if it is defined then the event loop has already been detected, and the
951	array will be ignored.	990	array will be ignored.
952		991
953	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	992	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
954	it,as it takes care of these details.	993	it, as it takes care of these details.
955		994
956	This variable is mainly useful for modules that can do something useful	995	This variable is mainly useful for modules that can do something useful
957	when AnyEvent is used and thus want to know when it is initialised, but do	996	when AnyEvent is used and thus want to know when it is initialised, but do
958	not need to even load it by default. This array provides the means to hook	997	not need to even load it by default. This array provides the means to hook
959	into AnyEvent passively, without loading it.	998	into AnyEvent passively, without loading it.
960		999
		1000	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1001	together, you could put this into Coro (this is the actual code used by
		1002	Coro to accomplish this):
		1003
		1004	if (defined $AnyEvent::MODEL) {
		1005	# AnyEvent already initialised, so load Coro::AnyEvent
		1006	require Coro::AnyEvent;
		1007	} else {
		1008	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1009	# as soon as it is
		1010	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1011	}
		1012
961	=back	1013	=back
962		1014
963	=head1 WHAT TO DO IN A MODULE	1015	=head1 WHAT TO DO IN A MODULE
964		1016
965	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1017	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
975	because it will stall the whole program, and the whole point of using	1027	because it will stall the whole program, and the whole point of using
976	events is to stay interactive.	1028	events is to stay interactive.
977		1029
978	It is fine, however, to call C<< ->recv >> when the user of your module	1030	It is fine, however, to call C<< ->recv >> when the user of your module
979	requests it (i.e. if you create a http request object ad have a method	1031	requests it (i.e. if you create a http request object ad have a method
980	called C<results> that returns the results, it should call C<< ->recv >>	1032	called C<results> that returns the results, it may call C<< ->recv >>
981	freely, as the user of your module knows what she is doing. always).	1033	freely, as the user of your module knows what she is doing. Always).
982		1034
983	=head1 WHAT TO DO IN THE MAIN PROGRAM	1035	=head1 WHAT TO DO IN THE MAIN PROGRAM
984		1036
985	There will always be a single main program - the only place that should	1037	There will always be a single main program - the only place that should
986	dictate which event model to use.	1038	dictate which event model to use.
987		1039
988	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1040	If the program is not event-based, it need not do anything special, even
989	do anything special (it does not need to be event-based) and let AnyEvent	1041	when it depends on a module that uses an AnyEvent. If the program itself
990	decide which implementation to chose if some module relies on it.	1042	uses AnyEvent, but does not care which event loop is used, all it needs
		1043	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1044	available loop implementation.
991		1045
992	If the main program relies on a specific event model - for example, in	1046	If the main program relies on a specific event model - for example, in
993	Gtk2 programs you have to rely on the Glib module - you should load the	1047	Gtk2 programs you have to rely on the Glib module - you should load the
994	event module before loading AnyEvent or any module that uses it: generally	1048	event module before loading AnyEvent or any module that uses it: generally
995	speaking, you should load it as early as possible. The reason is that	1049	speaking, you should load it as early as possible. The reason is that
996	modules might create watchers when they are loaded, and AnyEvent will	1050	modules might create watchers when they are loaded, and AnyEvent will
997	decide on the event model to use as soon as it creates watchers, and it	1051	decide on the event model to use as soon as it creates watchers, and it
998	might chose the wrong one unless you load the correct one yourself.	1052	might choose the wrong one unless you load the correct one yourself.
999		1053
1000	You can chose to use a pure-perl implementation by loading the	1054	You can chose to use a pure-perl implementation by loading the
1001	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1055	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
1002	everywhere, but letting AnyEvent chose the model is generally better.	1056	everywhere, but letting AnyEvent chose the model is generally better.
1003		1057
…		…
1021	=head1 OTHER MODULES	1075	=head1 OTHER MODULES
1022		1076
1023	The following is a non-exhaustive list of additional modules that use	1077	The following is a non-exhaustive list of additional modules that use
1024	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1078	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1025	modules and other event loops in the same program. Some of the modules	1079	modules and other event loops in the same program. Some of the modules
1026	come with AnyEvent, most are available via CPAN.	1080	come as part of AnyEvent, the others are available via CPAN.
1027		1081
1028	=over 4	1082	=over 4
1029		1083
1030	=item L<AnyEvent::Util>	1084	=item L<AnyEvent::Util>
1031		1085
1032	Contains various utility functions that replace often-used but blocking	1086	Contains various utility functions that replace often-used blocking
1033	functions such as C<inet_aton> by event-/callback-based versions.	1087	functions such as C<inet_aton> with event/callback-based versions.
1034		1088
1035	=item L<AnyEvent::Socket>	1089	=item L<AnyEvent::Socket>
1036		1090
1037	Provides various utility functions for (internet protocol) sockets,	1091	Provides various utility functions for (internet protocol) sockets,
1038	addresses and name resolution. Also functions to create non-blocking tcp	1092	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1040		1094
1041	=item L<AnyEvent::Handle>	1095	=item L<AnyEvent::Handle>
1042		1096
1043	Provide read and write buffers, manages watchers for reads and writes,	1097	Provide read and write buffers, manages watchers for reads and writes,
1044	supports raw and formatted I/O, I/O queued and fully transparent and	1098	supports raw and formatted I/O, I/O queued and fully transparent and
1045	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1099	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1046		1100
1047	=item L<AnyEvent::DNS>	1101	=item L<AnyEvent::DNS>
1048		1102
1049	Provides rich asynchronous DNS resolver capabilities.	1103	Provides rich asynchronous DNS resolver capabilities.
1050		1104
		1105	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1106
		1107	Implement event-based interfaces to the protocols of the same name (for
		1108	the curious, IGS is the International Go Server and FCP is the Freenet
		1109	Client Protocol).
		1110
		1111	=item L<AnyEvent::Handle::UDP>
		1112
		1113	Here be danger!
		1114
		1115	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1116	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1117	its use of a stream-based API with a protocol that isn't streamable, that
		1118	the only way to improve it is to delete it.
		1119
		1120	It features data corruption (but typically only under load) and general
		1121	confusion. On top, the author is not only clueless about UDP but also
		1122	fact-resistant - some gems of his understanding: "connect doesn't work
		1123	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1124	packets", "I don't need to implement proper error checking as UDP doesn't
		1125	support error checking" and so on - he doesn't even understand what's
		1126	wrong with his module when it is explained to him.
		1127
1051	=item L<AnyEvent::HTTP>	1128	=item L<AnyEvent::DBI>
1052		1129
1053	A simple-to-use HTTP library that is capable of making a lot of concurrent	1130	Executes L<DBI> requests asynchronously in a proxy process for you,
1054	HTTP requests.	1131	notifying you in an event-based way when the operation is finished.
		1132
		1133	=item L<AnyEvent::AIO>
		1134
		1135	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1136	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1137	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1138	file I/O, and much more.
1055		1139
1056	=item L<AnyEvent::HTTPD>	1140	=item L<AnyEvent::HTTPD>
1057		1141
1058	Provides a simple web application server framework.	1142	A simple embedded webserver.
1059		1143
1060	=item L<AnyEvent::FastPing>	1144	=item L<AnyEvent::FastPing>
1061		1145
1062	The fastest ping in the west.	1146	The fastest ping in the west.
1063
1064	=item L<AnyEvent::DBI>
1065
1066	Executes L<DBI> requests asynchronously in a proxy process.
1067
1068	=item L<AnyEvent::AIO>
1069
1070	Truly asynchronous I/O, should be in the toolbox of every event
1071	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1072	together.
1073
1074	=item L<AnyEvent::BDB>
1075
1076	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1077	L<BDB> and AnyEvent together.
1078
1079	=item L<AnyEvent::GPSD>
1080
1081	A non-blocking interface to gpsd, a daemon delivering GPS information.
1082
1083	=item L<AnyEvent::IRC>
1084
1085	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1086
1087	=item L<AnyEvent::XMPP>
1088
1089	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1090	Net::XMPP2>.
1091
1092	=item L<AnyEvent::IGS>
1093
1094	A non-blocking interface to the Internet Go Server protocol (used by
1095	L<App::IGS>).
1096
1097	=item L<Net::FCP>
1098
1099	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1100	of AnyEvent.
1101
1102	=item L<Event::ExecFlow>
1103
1104	High level API for event-based execution flow control.
1105		1147
1106	=item L<Coro>	1148	=item L<Coro>
1107		1149
1108	Has special support for AnyEvent via L<Coro::AnyEvent>.	1150	Has special support for AnyEvent via L<Coro::AnyEvent>.
1109		1151
…		…
1113		1155
1114	package AnyEvent;	1156	package AnyEvent;
1115		1157
1116	# basically a tuned-down version of common::sense	1158	# basically a tuned-down version of common::sense
1117	sub common_sense {	1159	sub common_sense {
1118	# from common:.sense 1.0	1160	# from common:.sense 3.3
1119	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";	1161	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";
1120	# use strict vars subs	1162	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1121	$^H \|= 0x00000600;	1163	$^H \|= 0x00000600;
1122	}	1164	}
1123		1165
1124	BEGIN { AnyEvent::common_sense }	1166	BEGIN { AnyEvent::common_sense }
1125		1167
1126	use Carp ();	1168	use Carp ();
1127		1169
1128	our $VERSION = '5.21';	1170	our $VERSION = '5.271';
1129	our $MODEL;	1171	our $MODEL;
1130		1172
1131	our $AUTOLOAD;	1173	our $AUTOLOAD;
1132	our @ISA;	1174	our @ISA;
1133		1175
1134	our @REGISTRY;	1176	our @REGISTRY;
1135		1177
1136	our $VERBOSE;	1178	our $VERBOSE;
1137		1179
1138	BEGIN {	1180	BEGIN {
1139	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1181	require "AnyEvent/constants.pl";
		1182
1140	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1183	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1141		1184
1142	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1185	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1143	if ${^TAINT};	1186	if ${^TAINT};
1144		1187
1145	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1188	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1188	our @post_detect;	1231	our @post_detect;
1189		1232
1190	sub post_detect(&) {	1233	sub post_detect(&) {
1191	my ($cb) = @_;	1234	my ($cb) = @_;
1192		1235
1193	if ($MODEL) {
1194	$cb->();
1195
1196	undef
1197	} else {
1198	push @post_detect, $cb;	1236	push @post_detect, $cb;
1199		1237
1200	defined wantarray	1238	defined wantarray
1201	? bless \$cb, "AnyEvent::Util::postdetect"	1239	? bless \$cb, "AnyEvent::Util::postdetect"
1202	: ()	1240	: ()
1203	}
1204	}	1241	}
1205		1242
1206	sub AnyEvent::Util::postdetect::DESTROY {	1243	sub AnyEvent::Util::postdetect::DESTROY {
1207	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1244	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1208	}	1245	}
1209		1246
1210	sub detect() {	1247	sub detect() {
		1248	# free some memory
		1249	*detect = sub () { $MODEL };
		1250
		1251	local $!; # for good measure
		1252	local $SIG{__DIE__};
		1253
		1254	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1255	my $model = "AnyEvent::Impl::$1";
		1256	if (eval "require $model") {
		1257	$MODEL = $model;
		1258	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1259	} else {
		1260	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1261	}
		1262	}
		1263
		1264	# check for already loaded models
1211	unless ($MODEL) {	1265	unless ($MODEL) {
1212	local $SIG{__DIE__};	1266	for (@REGISTRY, @models) {
1213		1267	my ($package, $model) = @$_;
1214	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1268	if (${"$package\::VERSION"} > 0) {
1215	my $model = "AnyEvent::Impl::$1";
1216	if (eval "require $model") {	1269	if (eval "require $model") {
1217	$MODEL = $model;	1270	$MODEL = $model;
1218	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1271	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1219	} else {	1272	last;
1220	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1273	}
1221	}	1274	}
1222	}	1275	}
1223		1276
1224	# check for already loaded models
1225	unless ($MODEL) {	1277	unless ($MODEL) {
		1278	# try to autoload a model
1226	for (@REGISTRY, @models) {	1279	for (@REGISTRY, @models) {
1227	my ($package, $model) = @$_;	1280	my ($package, $model, $autoload) = @$_;
		1281	if (
		1282	$autoload
		1283	and eval "require $package"
1228	if (${"$package\::VERSION"} > 0) {	1284	and ${"$package\::VERSION"} > 0
1229	if (eval "require $model") {	1285	and eval "require $model"
		1286	) {
1230	$MODEL = $model;	1287	$MODEL = $model;
1231	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1288	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1232	last;	1289	last;
1233	}
1234	}	1290	}
1235	}	1291	}
1236		1292
1237	unless ($MODEL) {
1238	# try to autoload a model
1239	for (@REGISTRY, @models) {
1240	my ($package, $model, $autoload) = @$_;
1241	if (
1242	$autoload
1243	and eval "require $package"
1244	and ${"$package\::VERSION"} > 0
1245	and eval "require $model"
1246	) {
1247	$MODEL = $model;
1248	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1249	last;
1250	}
1251	}
1252
1253	$MODEL	1293	$MODEL
1254	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1294	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1255	}
1256	}	1295	}
1257
1258	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1259
1260	unshift @ISA, $MODEL;
1261
1262	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1263
1264	(shift @post_detect)->() while @post_detect;
1265	}	1296	}
		1297
		1298	@models = (); # free probe data
		1299
		1300	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1301	unshift @ISA, $MODEL;
		1302
		1303	# now nuke some methods that are overriden by the backend.
		1304	# SUPER is not allowed.
		1305	for (qw(time signal child idle)) {
		1306	undef &{"AnyEvent::Base::$_"}
		1307	if defined &{"$MODEL\::$_"};
		1308	}
		1309
		1310	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1311
		1312	(shift @post_detect)->() while @post_detect;
		1313
		1314	*post_detect = sub(&) {
		1315	shift->();
		1316
		1317	undef
		1318	};
1266		1319
1267	$MODEL	1320	$MODEL
1268	}	1321	}
1269		1322
1270	sub AUTOLOAD {	1323	sub AUTOLOAD {
1271	(my $func = $AUTOLOAD) =~ s/.*://;	1324	(my $func = $AUTOLOAD) =~ s/.*://;
1272		1325
1273	$method{$func}	1326	$method{$func}
1274	or Carp::croak "$func: not a valid method for AnyEvent objects";	1327	or Carp::croak "$func: not a valid AnyEvent class method";
1275		1328
1276	detect unless $MODEL;	1329	detect;
1277		1330
1278	my $class = shift;	1331	my $class = shift;
1279	$class->$func (@_);	1332	$class->$func (@_);
1280	}	1333	}
1281		1334
…		…
1298		1351
1299	=head1 SIMPLIFIED AE API	1352	=head1 SIMPLIFIED AE API
1300		1353
1301	Starting with version 5.0, AnyEvent officially supports a second, much	1354	Starting with version 5.0, AnyEvent officially supports a second, much
1302	simpler, API that is designed to reduce the calling, typing and memory	1355	simpler, API that is designed to reduce the calling, typing and memory
1303	overhead.	1356	overhead by using function call syntax and a fixed number of parameters.
1304		1357
1305	See the L<AE> manpage for details.	1358	See the L<AE> manpage for details.
1306		1359
1307	=cut	1360	=cut
1308		1361
1309	package AE;	1362	package AE;
1310		1363
1311	our $VERSION = $AnyEvent::VERSION;	1364	our $VERSION = $AnyEvent::VERSION;
		1365
		1366	# fall back to the main API by default - backends and AnyEvent::Base
		1367	# implementations can overwrite these.
1312		1368
1313	sub io($$$) {	1369	sub io($$$) {
1314	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1370	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1315	}	1371	}
1316		1372
…		…
1348		1404
1349	package AnyEvent::Base;	1405	package AnyEvent::Base;
1350		1406
1351	# default implementations for many methods	1407	# default implementations for many methods
1352		1408
1353	sub _time() {	1409	sub time {
		1410	eval q{ # poor man's autoloading {}
1354	# probe for availability of Time::HiRes	1411	# probe for availability of Time::HiRes
1355	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1412	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1356	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1413	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1357	*_time = \&Time::HiRes::time;	1414	*AE::time = \&Time::HiRes::time;
1358	# if (eval "use POSIX (); (POSIX::times())...	1415	# if (eval "use POSIX (); (POSIX::times())...
1359	} else {	1416	} else {
1360	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1417	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1361	*_time = sub { time }; # epic fail	1418	*AE::time = sub (){ time }; # epic fail
		1419	}
		1420
		1421	*time = sub { AE::time }; # different prototypes
1362	}	1422	};
		1423	die if $@;
1363		1424
1364	&_time	1425	&time
1365	}	1426	}
1366		1427
1367	sub time { _time }	1428	*now = \&time;
1368	sub now { _time }	1429
1369	sub now_update { }	1430	sub now_update { }
1370		1431
1371	# default implementation for ->condvar	1432	# default implementation for ->condvar
1372		1433
1373	sub condvar {	1434	sub condvar {
		1435	eval q{ # poor man's autoloading {}
		1436	*condvar = sub {
1374	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1437	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1438	};
		1439
		1440	*AE::cv = sub (;&) {
		1441	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1442	};
		1443	};
		1444	die if $@;
		1445
		1446	&condvar
1375	}	1447	}
1376		1448
1377	# default implementation for ->signal	1449	# default implementation for ->signal
1378		1450
1379	our $HAVE_ASYNC_INTERRUPT;	1451	our $HAVE_ASYNC_INTERRUPT;
…		…
1388		1460
1389	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1461	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1390	our (%SIG_ASY, %SIG_ASY_W);	1462	our (%SIG_ASY, %SIG_ASY_W);
1391	our ($SIG_COUNT, $SIG_TW);	1463	our ($SIG_COUNT, $SIG_TW);
1392		1464
1393	sub _signal_exec {
1394	$HAVE_ASYNC_INTERRUPT
1395	? $SIGPIPE_R->drain
1396	: sysread $SIGPIPE_R, (my $dummy), 9;
1397
1398	while (%SIG_EV) {
1399	for (keys %SIG_EV) {
1400	delete $SIG_EV{$_};
1401	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1402	}
1403	}
1404	}
1405
1406	# install a dummy wakeup watcher to reduce signal catching latency	1465	# install a dummy wakeup watcher to reduce signal catching latency
		1466	# used by Impls
1407	sub _sig_add() {	1467	sub _sig_add() {
1408	unless ($SIG_COUNT++) {	1468	unless ($SIG_COUNT++) {
1409	# try to align timer on a full-second boundary, if possible	1469	# try to align timer on a full-second boundary, if possible
1410	my $NOW = AE::now;	1470	my $NOW = AE::now;
1411		1471
…		…
1421	undef $SIG_TW	1481	undef $SIG_TW
1422	unless --$SIG_COUNT;	1482	unless --$SIG_COUNT;
1423	}	1483	}
1424		1484
1425	our $_sig_name_init; $_sig_name_init = sub {	1485	our $_sig_name_init; $_sig_name_init = sub {
1426	eval q{ # poor man's autoloading	1486	eval q{ # poor man's autoloading {}
1427	undef $_sig_name_init;	1487	undef $_sig_name_init;
1428		1488
1429	if (_have_async_interrupt) {	1489	if (_have_async_interrupt) {
1430	*sig2num = \&Async::Interrupt::sig2num;	1490	*sig2num = \&Async::Interrupt::sig2num;
1431	*sig2name = \&Async::Interrupt::sig2name;	1491	*sig2name = \&Async::Interrupt::sig2name;
…		…
1463	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1523	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1464		1524
1465	} else {	1525	} else {
1466	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1526	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1467		1527
1468	require Fcntl;
1469
1470	if (AnyEvent::WIN32) {	1528	if (AnyEvent::WIN32) {
1471	require AnyEvent::Util;	1529	require AnyEvent::Util;
1472		1530
1473	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1531	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1474	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1532	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1475	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1533	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1476	} else {	1534	} else {
1477	pipe $SIGPIPE_R, $SIGPIPE_W;	1535	pipe $SIGPIPE_R, $SIGPIPE_W;
1478	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1536	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1479	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1537	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1480		1538
1481	# not strictly required, as $^F is normally 2, but let's make sure...	1539	# not strictly required, as $^F is normally 2, but let's make sure...
1482	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1540	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1483	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1541	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1484	}	1542	}
1485		1543
1486	$SIGPIPE_R	1544	$SIGPIPE_R
1487	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1545	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1488		1546
1489	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1547	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1490	}	1548	}
1491		1549
1492	*signal = sub {	1550	*signal = $HAVE_ASYNC_INTERRUPT
		1551	? sub {
1493	my (undef, %arg) = @_;	1552	my (undef, %arg) = @_;
1494		1553
1495	my $signal = uc $arg{signal}
1496	or Carp::croak "required option 'signal' is missing";
1497
1498	if ($HAVE_ASYNC_INTERRUPT) {
1499	# async::interrupt	1554	# async::interrupt
1500
1501	$signal = sig2num $signal;	1555	my $signal = sig2num $arg{signal};
1502	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1556	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1503		1557
1504	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1558	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1505	cb => sub { undef $SIG_EV{$signal} },	1559	cb => sub { undef $SIG_EV{$signal} },
1506	signal => $signal,	1560	signal => $signal,
1507	pipe => [$SIGPIPE_R->filenos],	1561	pipe => [$SIGPIPE_R->filenos],
1508	pipe_autodrain => 0,	1562	pipe_autodrain => 0,
1509	;	1563	;
1510		1564
1511	} else {	1565	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1566	}
		1567	: sub {
		1568	my (undef, %arg) = @_;
		1569
1512	# pure perl	1570	# pure perl
1513
1514	# AE::Util has been loaded in signal
1515	$signal = sig2name $signal;	1571	my $signal = sig2name $arg{signal};
1516	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1572	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1517		1573
1518	$SIG{$signal} \|\|= sub {	1574	$SIG{$signal} \|\|= sub {
1519	local $!;	1575	local $!;
1520	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1576	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1521	undef $SIG_EV{$signal};	1577	undef $SIG_EV{$signal};
1522	};	1578	};
1523		1579
1524	# can't do signal processing without introducing races in pure perl,	1580	# can't do signal processing without introducing races in pure perl,
1525	# so limit the signal latency.	1581	# so limit the signal latency.
1526	_sig_add;	1582	_sig_add;
1527	}
1528		1583
1529	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1584	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1585	}
1530	};	1586	;
1531		1587
1532	*AnyEvent::Base::signal::DESTROY = sub {	1588	*AnyEvent::Base::signal::DESTROY = sub {
1533	my ($signal, $cb) = @{$_[0]};	1589	my ($signal, $cb) = @{$_[0]};
1534		1590
1535	_sig_del;	1591	_sig_del;
…		…
1542	# print weird messages, or just unconditionally exit	1598	# print weird messages, or just unconditionally exit
1543	# instead of getting the default action.	1599	# instead of getting the default action.
1544	undef $SIG{$signal}	1600	undef $SIG{$signal}
1545	unless keys %{ $SIG_CB{$signal} };	1601	unless keys %{ $SIG_CB{$signal} };
1546	};	1602	};
		1603
		1604	*_signal_exec = sub {
		1605	$HAVE_ASYNC_INTERRUPT
		1606	? $SIGPIPE_R->drain
		1607	: sysread $SIGPIPE_R, (my $dummy), 9;
		1608
		1609	while (%SIG_EV) {
		1610	for (keys %SIG_EV) {
		1611	delete $SIG_EV{$_};
		1612	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1613	}
		1614	}
		1615	};
1547	};	1616	};
1548	die if $@;	1617	die if $@;
		1618
1549	&signal	1619	&signal
1550	}	1620	}
1551		1621
1552	# default implementation for ->child	1622	# default implementation for ->child
1553		1623
1554	our %PID_CB;	1624	our %PID_CB;
1555	our $CHLD_W;	1625	our $CHLD_W;
1556	our $CHLD_DELAY_W;	1626	our $CHLD_DELAY_W;
1557	our $WNOHANG;	1627	our $WNOHANG;
1558		1628
		1629	# used by many Impl's
1559	sub _emit_childstatus($$) {	1630	sub _emit_childstatus($$) {
1560	my (undef, $rpid, $rstatus) = @_;	1631	my (undef, $rpid, $rstatus) = @_;
1561		1632
1562	$_->($rpid, $rstatus)	1633	$_->($rpid, $rstatus)
1563	for values %{ $PID_CB{$rpid} \|\| {} },	1634	for values %{ $PID_CB{$rpid} \|\| {} },
1564	values %{ $PID_CB{0} \|\| {} };	1635	values %{ $PID_CB{0} \|\| {} };
1565	}	1636	}
1566		1637
1567	sub _sigchld {
1568	my $pid;
1569
1570	AnyEvent->_emit_childstatus ($pid, $?)
1571	while ($pid = waitpid -1, $WNOHANG) > 0;
1572	}
1573
1574	sub child {	1638	sub child {
		1639	eval q{ # poor man's autoloading {}
		1640	*_sigchld = sub {
		1641	my $pid;
		1642
		1643	AnyEvent->_emit_childstatus ($pid, $?)
		1644	while ($pid = waitpid -1, $WNOHANG) > 0;
		1645	};
		1646
		1647	*child = sub {
1575	my (undef, %arg) = @_;	1648	my (undef, %arg) = @_;
1576		1649
1577	defined (my $pid = $arg{pid} + 0)	1650	defined (my $pid = $arg{pid} + 0)
1578	or Carp::croak "required option 'pid' is missing";	1651	or Carp::croak "required option 'pid' is missing";
1579		1652
1580	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1653	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1581		1654
1582	# WNOHANG is almost cetrainly 1 everywhere	1655	# WNOHANG is almost cetrainly 1 everywhere
1583	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1656	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1584	? 1	1657	? 1
1585	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1658	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1586		1659
1587	unless ($CHLD_W) {	1660	unless ($CHLD_W) {
1588	$CHLD_W = AE::signal CHLD => \&_sigchld;	1661	$CHLD_W = AE::signal CHLD => \&_sigchld;
1589	# child could be a zombie already, so make at least one round	1662	# child could be a zombie already, so make at least one round
1590	&_sigchld;	1663	&_sigchld;
1591	}	1664	}
1592		1665
1593	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1666	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1594	}	1667	};
1595		1668
1596	sub AnyEvent::Base::child::DESTROY {	1669	*AnyEvent::Base::child::DESTROY = sub {
1597	my ($pid, $cb) = @{$_[0]};	1670	my ($pid, $cb) = @{$_[0]};
1598		1671
1599	delete $PID_CB{$pid}{$cb};	1672	delete $PID_CB{$pid}{$cb};
1600	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1673	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1601		1674
1602	undef $CHLD_W unless keys %PID_CB;	1675	undef $CHLD_W unless keys %PID_CB;
		1676	};
		1677	};
		1678	die if $@;
		1679
		1680	&child
1603	}	1681	}
1604		1682
1605	# idle emulation is done by simply using a timer, regardless	1683	# idle emulation is done by simply using a timer, regardless
1606	# of whether the process is idle or not, and not letting	1684	# of whether the process is idle or not, and not letting
1607	# the callback use more than 50% of the time.	1685	# the callback use more than 50% of the time.
1608	sub idle {	1686	sub idle {
		1687	eval q{ # poor man's autoloading {}
		1688	*idle = sub {
1609	my (undef, %arg) = @_;	1689	my (undef, %arg) = @_;
1610		1690
1611	my ($cb, $w, $rcb) = $arg{cb};	1691	my ($cb, $w, $rcb) = $arg{cb};
1612		1692
1613	$rcb = sub {	1693	$rcb = sub {
1614	if ($cb) {	1694	if ($cb) {
1615	$w = _time;	1695	$w = _time;
1616	&$cb;	1696	&$cb;
1617	$w = _time - $w;	1697	$w = _time - $w;
1618		1698
1619	# never use more then 50% of the time for the idle watcher,	1699	# never use more then 50% of the time for the idle watcher,
1620	# within some limits	1700	# within some limits
1621	$w = 0.0001 if $w < 0.0001;	1701	$w = 0.0001 if $w < 0.0001;
1622	$w = 5 if $w > 5;	1702	$w = 5 if $w > 5;
1623		1703
1624	$w = AE::timer $w, 0, $rcb;	1704	$w = AE::timer $w, 0, $rcb;
1625	} else {	1705	} else {
1626	# clean up...	1706	# clean up...
1627	undef $w;	1707	undef $w;
1628	undef $rcb;	1708	undef $rcb;
		1709	}
		1710	};
		1711
		1712	$w = AE::timer 0.05, 0, $rcb;
		1713
		1714	bless \\$cb, "AnyEvent::Base::idle"
1629	}	1715	};
		1716
		1717	*AnyEvent::Base::idle::DESTROY = sub {
		1718	undef $${$_[0]};
		1719	};
1630	};	1720	};
		1721	die if $@;
1631		1722
1632	$w = AE::timer 0.05, 0, $rcb;	1723	&idle
1633
1634	bless \\$cb, "AnyEvent::Base::idle"
1635	}
1636
1637	sub AnyEvent::Base::idle::DESTROY {
1638	undef $${$_[0]};
1639	}	1724	}
1640		1725
1641	package AnyEvent::CondVar;	1726	package AnyEvent::CondVar;
1642		1727
1643	our @ISA = AnyEvent::CondVar::Base::;	1728	our @ISA = AnyEvent::CondVar::Base::;
…		…
1770	check the arguments passed to most method calls. If it finds any problems,	1855	check the arguments passed to most method calls. If it finds any problems,
1771	it will croak.	1856	it will croak.
1772		1857
1773	In other words, enables "strict" mode.	1858	In other words, enables "strict" mode.
1774		1859
1775	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	1860	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1776	>>, it is definitely recommended to keep it off in production. Keeping	1861	>>, it is definitely recommended to keep it off in production. Keeping
1777	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1862	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1778	can be very useful, however.	1863	can be very useful, however.
1779		1864
1780	=item C<PERL_ANYEVENT_MODEL>	1865	=item C<PERL_ANYEVENT_MODEL>
…		…
2002		2087
2003	The actual code goes further and collects all errors (C<die>s, exceptions)	2088	The actual code goes further and collects all errors (C<die>s, exceptions)
2004	that occurred during request processing. The C<result> method detects	2089	that occurred during request processing. The C<result> method detects
2005	whether an exception as thrown (it is stored inside the $txn object)	2090	whether an exception as thrown (it is stored inside the $txn object)
2006	and just throws the exception, which means connection errors and other	2091	and just throws the exception, which means connection errors and other
2007	problems get reported tot he code that tries to use the result, not in a	2092	problems get reported to the code that tries to use the result, not in a
2008	random callback.	2093	random callback.
2009		2094
2010	All of this enables the following usage styles:	2095	All of this enables the following usage styles:
2011		2096
2012	1. Blocking:	2097	1. Blocking:
…		…
2426	unless defined $SIG{PIPE};	2511	unless defined $SIG{PIPE};
2427		2512
2428	=head1 RECOMMENDED/OPTIONAL MODULES	2513	=head1 RECOMMENDED/OPTIONAL MODULES
2429		2514
2430	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2515	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2431	it's built-in modules) are required to use it.	2516	its built-in modules) are required to use it.
2432		2517
2433	That does not mean that AnyEvent won't take advantage of some additional	2518	That does not mean that AnyEvent won't take advantage of some additional
2434	modules if they are installed.	2519	modules if they are installed.
2435		2520
2436	This section epxlains which additional modules will be used, and how they	2521	This section explains which additional modules will be used, and how they
2437	affect AnyEvent's operetion.	2522	affect AnyEvent's operation.
2438		2523
2439	=over 4	2524	=over 4
2440		2525
2441	=item L<Async::Interrupt>	2526	=item L<Async::Interrupt>
2442		2527
…		…
2447	catch the signals) with some delay (default is 10 seconds, look for	2532	catch the signals) with some delay (default is 10 seconds, look for
2448	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2533	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2449		2534
2450	If this module is available, then it will be used to implement signal	2535	If this module is available, then it will be used to implement signal
2451	catching, which means that signals will not be delayed, and the event loop	2536	catching, which means that signals will not be delayed, and the event loop
2452	will not be interrupted regularly, which is more efficient (And good for	2537	will not be interrupted regularly, which is more efficient (and good for
2453	battery life on laptops).	2538	battery life on laptops).
2454		2539
2455	This affects not just the pure-perl event loop, but also other event loops	2540	This affects not just the pure-perl event loop, but also other event loops
2456	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2541	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2457		2542
…		…
2469	automatic timer adjustments even when no monotonic clock is available,	2554	automatic timer adjustments even when no monotonic clock is available,
2470	can take avdantage of advanced kernel interfaces such as C<epoll> and	2555	can take avdantage of advanced kernel interfaces such as C<epoll> and
2471	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2556	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2472	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2557	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2473		2558
		2559	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2560	then this module will do nothing for you.
		2561
2474	=item L<Guard>	2562	=item L<Guard>
2475		2563
2476	The guard module, when used, will be used to implement	2564	The guard module, when used, will be used to implement
2477	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2565	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2478	lot less memory), but otherwise doesn't affect guard operation much. It is	2566	lot less memory), but otherwise doesn't affect guard operation much. It is
2479	purely used for performance.	2567	purely used for performance.
2480		2568
2481	=item L<JSON> and L<JSON::XS>	2569	=item L<JSON> and L<JSON::XS>
2482		2570
2483	One of these modules is required when you want to read or write JSON data	2571	One of these modules is required when you want to read or write JSON data
2484	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2572	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2485	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2573	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2486
2487	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2488	installed.
2489		2574
2490	=item L<Net::SSLeay>	2575	=item L<Net::SSLeay>
2491		2576
2492	Implementing TLS/SSL in Perl is certainly interesting, but not very	2577	Implementing TLS/SSL in Perl is certainly interesting, but not very
2493	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2578	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2494	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2579	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2495		2580
2496	=item L<Time::HiRes>	2581	=item L<Time::HiRes>
2497		2582
2498	This module is part of perl since release 5.008. It will be used when the	2583	This module is part of perl since release 5.008. It will be used when the
2499	chosen event library does not come with a timing source on it's own. The	2584	chosen event library does not come with a timing source of its own. The
2500	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2585	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2501	try to use a monotonic clock for timing stability.	2586	try to use a monotonic clock for timing stability.
2502		2587
2503	=back	2588	=back
2504		2589
2505		2590
2506	=head1 FORK	2591	=head1 FORK
2507		2592
2508	Most event libraries are not fork-safe. The ones who are usually are	2593	Most event libraries are not fork-safe. The ones who are usually are
2509	because they rely on inefficient but fork-safe C<select> or C<poll>	2594	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2510	calls. Only L<EV> is fully fork-aware.	2595	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2596	are usually badly thought-out hacks that are incompatible with fork in
		2597	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2598	continue event-processing in both parent and child (or both, if you know
		2599	what you are doing).
		2600
		2601	This means that, in general, you cannot fork and do event processing in
		2602	the child if the event library was initialised before the fork (which
		2603	usually happens when the first AnyEvent watcher is created, or the library
		2604	is loaded).
2511		2605
2512	If you have to fork, you must either do so I<before> creating your first	2606	If you have to fork, you must either do so I<before> creating your first
2513	watcher OR you must not use AnyEvent at all in the child OR you must do	2607	watcher OR you must not use AnyEvent at all in the child OR you must do
2514	something completely out of the scope of AnyEvent.	2608	something completely out of the scope of AnyEvent.
		2609
		2610	The problem of doing event processing in the parent I<and> the child
		2611	is much more complicated: even for backends that I<are> fork-aware or
		2612	fork-safe, their behaviour is not usually what you want: fork clones all
		2613	watchers, that means all timers, I/O watchers etc. are active in both
		2614	parent and child, which is almost never what you want. USing C<exec>
		2615	to start worker children from some kind of manage rprocess is usually
		2616	preferred, because it is much easier and cleaner, at the expense of having
		2617	to have another binary.
2515		2618
2516		2619
2517	=head1 SECURITY CONSIDERATIONS	2620	=head1 SECURITY CONSIDERATIONS
2518		2621
2519	AnyEvent can be forced to load any event model via	2622	AnyEvent can be forced to load any event model via

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.297 by root, Thu Nov 19 01:55:57 2009 UTC vs. Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.297 by root, Thu Nov 19 01:55:57 2009 UTC vs.
Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC