ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.278 by root, Sun Aug 9 15:09:28 2009 UTC vs.
Revision 1.370 by root, Wed Aug 17 02:50:35 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
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18		21
19	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21		24
22	# POSIX signal	25	# POSIX signal
…		…
43	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
45		48
46	=head1 SUPPORT	49	=head1 SUPPORT
47		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	53	There also is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	54	channel, too.
50		55
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	56	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Repository>, at L<http://anyevent.schmorp.de>, for more info.	57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		58
…		…
73	module users into the same thing by forcing them to use the same event	78	module users into the same thing by forcing them to use the same event
74	model you use.	79	model you use.
75		80
76	For modules like POE or IO::Async (which is a total misnomer as it is	81	For modules like POE or IO::Async (which is a total misnomer as it is
77	actually doing all I/O I<synchronously>...), using them in your module is	82	actually doing all I/O I<synchronously>...), using them in your module is
78	like joining a cult: After you joined, you are dependent on them and you	83	like joining a cult: After you join, you are dependent on them and you
79	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
80	that isn't them. What's worse, all the potential users of your	85	that isn't them. What's worse, all the potential users of your
81	module are I<also> forced to use the same event loop you use.	86	module are I<also> forced to use the same event loop you use.
82		87
83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
85	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
86	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
87	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
88	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
89	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,
90	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
91		96
92	In addition to being free of having to use I<the one and only true event	97	In addition to being free of having to use I<the one and only true event
93	model>, AnyEvent also is free of bloat and policy: with POE or similar	98	model>, AnyEvent also is free of bloat and policy: with POE or similar
94	modules, you get an enormous amount of code and strict rules you have to	99	modules, you get an enormous amount of code and strict rules you have to
95	follow. AnyEvent, on the other hand, is lean and up to the point, by only	100	follow. AnyEvent, on the other hand, is lean and to the point, by only
96	offering the functionality that is necessary, in as thin as a wrapper as	101	offering the functionality that is necessary, in as thin as a wrapper as
97	technically possible.	102	technically possible.
98		103
99	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
100	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
106	useful) and you want to force your users to use the one and only event	111	useful) and you want to force your users to use the one and only event
107	model, you should I<not> use this module.	112	model, you should I<not> use this module.
108		113
109	=head1 DESCRIPTION	114	=head1 DESCRIPTION
110		115
111	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
112	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
113	users to use the same event loop (as only a single event loop can coexist	118	module users to use a specific event loop implementation (since more
114	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
115		120
116	The interface itself is vaguely similar, but not identical to the L<Event>	121	The interface itself is vaguely similar, but not identical to the L<Event>
117	module.	122	module.
118		123
119	During the first call of any watcher-creation method, the module tries	124	During the first call of any watcher-creation method, the module tries
120	to detect the currently loaded event loop by probing whether one of the	125	to detect the currently loaded event loop by probing whether one of the
121	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
122	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
123	L<POE>. The first one found is used. If none are found, the module tries	128	found is used. If none are detected, the module tries to load the first
124	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	129	four modules in the order given; but note that if L<EV> is not
125	adaptor should always succeed) in the order given. The first one that can	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
126	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
127	found, AnyEvent will fall back to a pure-perl event loop, which is not
128	very efficient, but should work everywhere.
129		132
130	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
131	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
132	that model the default. For example:	135	that model the default. For example:
133		136
…		…
135	use AnyEvent;	138	use AnyEvent;
136		139
137	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
138		141
139	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
140	starts using it, all bets are off. Maybe you should tell their authors to	143	starts using it, all bets are off - this case should be very rare though,
141	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
142		146
143	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
144	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
145	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
146		150
147	=head1 WATCHERS	151	=head1 WATCHERS
148		152
149	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
150	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
…		…
155	callback when the event occurs (of course, only when the event model	159	callback when the event occurs (of course, only when the event model
156	is in control).	160	is in control).
157		161
158	Note that B<callbacks must not permanently change global variables>	162	Note that B<callbacks must not permanently change global variables>
159	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<	163	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
160	callbacks must not C<die> >>. The former is good programming practise in	164	callbacks must not C<die> >>. The former is good programming practice in
161	Perl and the latter stems from the fact that exception handling differs	165	Perl and the latter stems from the fact that exception handling differs
162	widely between event loops.	166	widely between event loops.
163		167
164	To disable the watcher you have to destroy it (e.g. by setting the	168	To disable a watcher you have to destroy it (e.g. by setting the
165	variable you store it in to C<undef> or otherwise deleting all references	169	variable you store it in to C<undef> or otherwise deleting all references
166	to it).	170	to it).
167		171
168	All watchers are created by calling a method on the C<AnyEvent> class.	172	All watchers are created by calling a method on the C<AnyEvent> class.
169		173
170	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
171	example), or need to refer to their watcher object in other ways.	175	example), or need to refer to their watcher object in other ways.
172		176
173	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
174		178
175	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
176	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
177	undef $w;	181	undef $w;
178	});	182	});
…		…
210		214
211	The I/O watcher might use the underlying file descriptor or a copy of it.	215	The I/O watcher might use the underlying file descriptor or a copy of it.
212	You must not close a file handle as long as any watcher is active on the	216	You must not close a file handle as long as any watcher is active on the
213	underlying file descriptor.	217	underlying file descriptor.
214		218
215	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
216	always use non-blocking calls when reading/writing from/to your file	220	always use non-blocking calls when reading/writing from/to your file
217	handles.	221	handles.
218		222
219	Example: wait for readability of STDIN, then read a line and disable the	223	Example: wait for readability of STDIN, then read a line and disable the
220	watcher.	224	watcher.
…		…
244		248
245	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
246	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
247	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
248		252
249	The callback will normally be invoked once only. If you specify another	253	The callback will normally be invoked only once. If you specify another
250	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
251	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
252	seconds) after the first invocation. If C<interval> is specified with a	256	seconds) after the first invocation. If C<interval> is specified with a
253	false value, then it is treated as if it were missing.	257	false value, then it is treated as if it were not specified at all.
254		258
255	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
256	attempt is done to avoid timer drift in most backends, so the interval is	260	attempt is made to avoid timer drift in most backends, so the interval is
257	only approximate.	261	only approximate.
258		262
259	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
260		264
261	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
279		283
280	While most event loops expect timers to specified in a relative way, they	284	While most event loops expect timers to specified in a relative way, they
281	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
282	"jumps", for example, when ntp decides to set your clock backwards from	286	"jumps", for example, when ntp decides to set your clock backwards from
283	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to	287	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
284	fire "after" a second might actually take six years to finally fire.	288	fire "after a second" might actually take six years to finally fire.
285		289
286	AnyEvent cannot compensate for this. The only event loop that is conscious	290	AnyEvent cannot compensate for this. The only event loop that is conscious
287	about these issues is L<EV>, which offers both relative (ev_timer, based	291	of these issues is L<EV>, which offers both relative (ev_timer, based
288	on true relative time) and absolute (ev_periodic, based on wallclock time)	292	on true relative time) and absolute (ev_periodic, based on wallclock time)
289	timers.	293	timers.
290		294
291	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
292	AnyEvent API.	296	AnyEvent API.
…		…
314	I<In almost all cases (in all cases if you don't care), this is the	318	I<In almost all cases (in all cases if you don't care), this is the
315	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
316		320
317	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
318	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
319	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
320		324
321	The rest of this section is only of relevance if you try to be very exact	325	The rest of this section is only of relevance if you try to be very exact
322	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
323		327
324	For a practical example of when these times differ, consider L<Event::Lib>	328	For a practical example of when these times differ, consider L<Event::Lib>
325	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
326		330
327	The event loop is running and has just invoked one of your callback at	331	The event loop is running and has just invoked one of your callbacks at
328	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
329	you wait a second by executing C<sleep 1> (blocking the process for a	333	you wait a second by executing C<sleep 1> (blocking the process for a
330	second) and then (at time=501) you create a relative timer that fires	334	second) and then (at time=501) you create a relative timer that fires
331	after three seconds.	335	after three seconds.
332		336
…		…
352	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
353	account.	357	account.
354		358
355	=item AnyEvent->now_update	359	=item AnyEvent->now_update
356		360
357	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
358	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 >>,
359	AnyEvent->now >>, above).	363	above).
360		364
361	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
362	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
363	might affect timers and time-outs.	367	might affect timers and time-outs.
364		368
365	When this is the case, you can call this method, which will update the	369	When this is the case, you can call this method, which will update the
366	event loop's idea of "current time".	370	event loop's idea of "current time".
		371
		372	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		373	when mod_perl executes the script, then the event loop will have the wrong
		374	idea about the "current time" (being potentially far in the past, when the
		375	script ran the last time). In that case you should arrange a call to C<<
		376	AnyEvent->now_update >> each time the web server process wakes up again
		377	(e.g. at the start of your script, or in a handler).
367		378
368	Note that updating the time I<might> cause some events to be handled.	379	Note that updating the time I<might> cause some events to be handled.
369		380
370	=back	381	=back
371		382
…		…
396		407
397	Example: exit on SIGINT	408	Example: exit on SIGINT
398		409
399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	410	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
400		411
		412	=head3 Restart Behaviour
		413
		414	While restart behaviour is up to the event loop implementation, most will
		415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		416	pure perl implementation).
		417
		418	=head3 Safe/Unsafe Signals
		419
		420	Perl signals can be either "safe" (synchronous to opcode handling) or
		421	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		422	latter might corrupt your memory.
		423
		424	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		425	i.e. they will not interrupt your running perl program but will only be
		426	called as part of the normal event handling (just like timer, I/O etc.
		427	callbacks, too).
		428
401	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
402		430
403	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
404	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
405	do race-free signal handling in perl, requiring C libraries for	433	do race-free signal handling in perl, requiring C libraries for
406	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,
407	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
408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
409	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,
410	and should be left alone otherwise. This variable determines how often	438	and should be left alone otherwise. This variable determines how often
411	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
…		…
413	saving.	441	saving.
414		442
415	All these problems can be avoided by installing the optional	443	All these problems can be avoided by installing the optional
416	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
417	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>
418	(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
419	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.
420		448
421	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
422		450
423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
424		452
425	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.
426		454
427	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,
428	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
429	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
430	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
431	(stopped/continued).	459	(stopped/continued).
432		460
…		…
454	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
455	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
456	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
457		485
458	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
459	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
460	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
461		489
462	Example: fork a process and wait for it	490	Example: fork a process and wait for it
463		491
464	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
465		493
…		…
479		507
480	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
481		509
482	$w = AnyEvent->idle (cb => <callback>);	510	$w = AnyEvent->idle (cb => <callback>);
483		511
484	Sometimes there is a need to do something, but it is not so important	512	This will repeatedly invoke the callback after the process becomes idle,
485	to do it instantly, but only when there is nothing better to do. This	513	until either the watcher is destroyed or new events have been detected.
486	"nothing better to do" is usually defined to be "no other events need
487	attention by the event loop".
488		514
489	Idle watchers ideally get invoked when the event loop has nothing	515	Idle watchers are useful when there is a need to do something, but it
490	better to do, just before it would block the process to wait for new	516	is not so important (or wise) to do it instantly. The callback will be
491	events. Instead of blocking, the idle watcher is invoked.	517	invoked only when there is "nothing better to do", which is usually
		518	defined as "all outstanding events have been handled and no new events
		519	have been detected". That means that idle watchers ideally get invoked
		520	when the event loop has just polled for new events but none have been
		521	detected. Instead of blocking to wait for more events, the idle watchers
		522	will be invoked.
492		523
493	Most event loops unfortunately do not really support idle watchers (only	524	Unfortunately, most event loops do not really support idle watchers (only
494	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	525	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495	will simply call the callback "from time to time".	526	will simply call the callback "from time to time".
496		527
497	Example: read lines from STDIN, but only process them when the	528	Example: read lines from STDIN, but only process them when the
498	program is otherwise idle:	529	program is otherwise idle:
…		…
526	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
527		558
528	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
529	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).
530		561
531	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
532	because they represent a condition that must become true.	563	they represent a condition that must become true.
533		564
534	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.
535		566
536	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
537	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
…		…
542	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
543	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
544	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<<
545	->send >> method).	576	->send >> method).
546		577
547	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
548	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:
549	in time where multiple outstanding events have been processed. And yet	580
550	another way to call them is transactions - each condition variable can be	581	=over 4
551	used to represent a transaction, which finishes at some point and delivers	582
552	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
553	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
554		601
555	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
556	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,
557	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
558	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
…		…
571		618
572	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
573	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
574	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
575	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
576	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
577		624
578	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
579	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
580	for the send to occur.	627	for the send to occur.
581		628
582	Example: wait for a timer.	629	Example: wait for a timer.
583		630
584	# wait till the result is ready	631	# condition: "wait till the timer is fired"
585	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
586		633
587	# do something such as adding a timer	634	# create the timer - we could wait for, say
588	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
589	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
590	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
591	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
592	after => 1,	639	after => 1,
593	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
594	);	641	);
595		642
596	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
597	# calls -<send	644	# calls ->send
598	$result_ready->recv;	645	$timer_fired->recv;
599		646
600	Example: wait for a timer, but take advantage of the fact that condition	647	Example: wait for a timer, but take advantage of the fact that condition
601	variables are also callable directly.	648	variables are also callable directly.
602		649
603	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
…		…
646	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
647	C<send>.	694	C<send>.
648		695
649	=item $cv->croak ($error)	696	=item $cv->croak ($error)
650		697
651	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
652	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
653		700
654	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
655	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
656	delays the error detetcion, but has the overwhelmign advantage that it	703	delays the error detection, but has the overwhelming advantage that it
657	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
658	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
659	the problem.	706	the problem.
660		707
661	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
662		709
663	=item $cv->end	710	=item $cv->end
…		…
666	one. For example, a function that pings many hosts in parallel might want	713	one. For example, a function that pings many hosts in parallel might want
667	to use a condition variable for the whole process.	714	to use a condition variable for the whole process.
668		715
669	Every call to C<< ->begin >> will increment a counter, and every call to	716	Every call to C<< ->begin >> will increment a counter, and every call to
670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	717	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
671	>>, the (last) callback passed to C<begin> will be executed. That callback	718	>>, the (last) callback passed to C<begin> will be executed, passing the
672	is I<supposed> to call C<< ->send >>, but that is not required. If no	719	condvar as first argument. That callback is I<supposed> to call C<< ->send
673	callback was set, C<send> will be called without any arguments.	720	>>, but that is not required. If no group callback was set, C<send> will
		721	be called without any arguments.
674		722
675	You can think of C<< $cv->send >> giving you an OR condition (one call	723	You can think of C<< $cv->send >> giving you an OR condition (one call
676	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	724	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	725	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678		726
…		…
700	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
701	sending.	749	sending.
702		750
703	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
704	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
705	begung can potentially be zero:	753	begun can potentially be zero:
706		754
707	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
708		756
709	my %result;	757	my %result;
710	$cv->begin (sub { $cv->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
711		759
712	for my $host (@list_of_hosts) {	760	for my $host (@list_of_hosts) {
713	$cv->begin;	761	$cv->begin;
714	ping_host_then_call_callback $host, sub {	762	ping_host_then_call_callback $host, sub {
715	$result{$host} = ...;	763	$result{$host} = ...;
…		…
731	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
732	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
733	doesn't execute once).	781	doesn't execute once).
734		782
735	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
736	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
737	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
738	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,
739	call C<end>.	787	call C<end>.
740		788
741	=back	789	=back
…		…
748	=over 4	796	=over 4
749		797
750	=item $cv->recv	798	=item $cv->recv
751		799
752	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
753	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
754	normally.	802	normally.
755		803
756	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
757	will return immediately.	805	will return immediately.
758		806
…		…
775	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
776	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
777	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,
778	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
779		827
780	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
781	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
782	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
783	waits otherwise.	831	waits otherwise.
784		832
785	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
790	=item $cb = $cv->cb ($cb->($cv))	838	=item $cb = $cv->cb ($cb->($cv))
791		839
792	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
793	replaces it before doing so.	841	replaces it before doing so.
794		842
795	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
796	"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
797	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
798	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.
799		848
800	=back	849	=back
801		850
802	=head1 SUPPORTED EVENT LOOPS/BACKENDS	851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
803		852
…		…
811	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
812	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
813	AnyEvent itself.	862	AnyEvent itself.
814		863
815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
817		866
818	=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.
819		868
820	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
821	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
822	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
823	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
824	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.
825		874
…		…
827	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
828	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
831	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).
832		884
833	=item Backends with special needs.	885	=item Backends with special needs.
834		886
835	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
836	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
837	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
838	everything should just work.	890	everything should just work.
839		891
840	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
841		893
842	Support for IO::Async can only be partial, as it is too broken and
843	architecturally limited to even support the AnyEvent API. It also
844	is the only event loop that needs the loop to be set explicitly, so
845	it can only be used by a main program knowing about AnyEvent. See
846	L<AnyEvent::Impl::Async> for the gory details.
847
848	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
849
850	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
851		895
852	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
853		897
854	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>.
…		…
879	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
880	backend has been autodetected.	924	backend has been autodetected.
881		925
882	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
883	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
884	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
885	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
886	will be C<urxvt::anyevent>).	930	will be C<urxvt::anyevent>).
887		931
888	=item AnyEvent::detect	932	=item AnyEvent::detect
889		933
890	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
891	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
892	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
893	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).
894		942
895	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
896	created, use C<post_detect>.	944	created, use C<post_detect>.
897		945
898	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
899		947
900	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
901	autodetected (or immediately if this has already happened).	949	autodetected (or immediately if that has already happened).
902		950
903	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
904	(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
905	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
906	other initialisations - see the sources of L<AnyEvent::Strict> or	954	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
915	that automatically removes the callback again when it is destroyed (or	963	that automatically removes the callback again when it is destroyed (or
916	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
917	a case where this is useful.	965	a case where this is useful.
918		966
919	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
920	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.
921		969
922	our WATCHER;	970	our WATCHER;
923		971
924	my $guard = AnyEvent::post_detect {	972	my $guard = AnyEvent::post_detect {
925	$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);
…		…
933	$WATCHER ||= $guard;	981	$WATCHER ||= $guard;
934		982
935	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
936		984
937	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
938	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will be called directly
939	the event loop has been chosen.	987	after the event loop has been chosen.
940		988
941	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:
942	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
943	array will be ignored.	991	array will be ignored.
944		992
945	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	993	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946	it,as it takes care of these details.	994	it, as it takes care of these details.
947		995
948	This variable is mainly useful for modules that can do something useful	996	This variable is mainly useful for modules that can do something useful
949	when AnyEvent is used and thus want to know when it is initialised, but do	997	when AnyEvent is used and thus want to know when it is initialised, but do
950	not need to even load it by default. This array provides the means to hook	998	not need to even load it by default. This array provides the means to hook
951	into AnyEvent passively, without loading it.	999	into AnyEvent passively, without loading it.
952		1000
		1001	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1002	together, you could put this into Coro (this is the actual code used by
		1003	Coro to accomplish this):
		1004
		1005	if (defined $AnyEvent::MODEL) {
		1006	# AnyEvent already initialised, so load Coro::AnyEvent
		1007	require Coro::AnyEvent;
		1008	} else {
		1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1010	# as soon as it is
		1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1012	}
		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
953	=back	1064	=back
954		1065
955	=head1 WHAT TO DO IN A MODULE	1066	=head1 WHAT TO DO IN A MODULE
956		1067
957	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
…		…
967	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
968	events is to stay interactive.	1079	events is to stay interactive.
969		1080
970	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
971	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
972	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 >>
973	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).
974		1085
975	=head1 WHAT TO DO IN THE MAIN PROGRAM	1086	=head1 WHAT TO DO IN THE MAIN PROGRAM
976		1087
977	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
978	dictate which event model to use.	1089	dictate which event model to use.
979		1090
980	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
981	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
982	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.
983		1096
984	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
985	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
986	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
987	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
988	modules might create watchers when they are loaded, and AnyEvent will	1101	modules might create watchers when they are loaded, and AnyEvent will
989	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
990	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.
991		1104
992	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
993	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1106	C<AnyEvent::Loop> module, which gives you similar behaviour
994	everywhere, but letting AnyEvent chose the model is generally better.	1107	everywhere, but letting AnyEvent chose the model is generally better.
995		1108
996	=head2 MAINLOOP EMULATION	1109	=head2 MAINLOOP EMULATION
997		1110
998	Sometimes (often for short test scripts, or even standalone programs who	1111	Sometimes (often for short test scripts, or even standalone programs who
…		…
1011		1124
1012		1125
1013	=head1 OTHER MODULES	1126	=head1 OTHER MODULES
1014		1127
1015	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
1016	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
1017	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
1018	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 :)
1019		1135
1020	=over 4	1136	=over 4
1021		1137
1022	=item L<AnyEvent::Util>	1138	=item L<AnyEvent::Util>
1023		1139
1024	Contains various utility functions that replace often-used but blocking	1140	Contains various utility functions that replace often-used blocking
1025	functions such as C<inet_aton> by event-/callback-based versions.	1141	functions such as C<inet_aton> with event/callback-based versions.
1026		1142
1027	=item L<AnyEvent::Socket>	1143	=item L<AnyEvent::Socket>
1028		1144
1029	Provides various utility functions for (internet protocol) sockets,	1145	Provides various utility functions for (internet protocol) sockets,
1030	addresses and name resolution. Also functions to create non-blocking tcp	1146	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1032		1148
1033	=item L<AnyEvent::Handle>	1149	=item L<AnyEvent::Handle>
1034		1150
1035	Provide read and write buffers, manages watchers for reads and writes,	1151	Provide read and write buffers, manages watchers for reads and writes,
1036	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
1037	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1153	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1038		1154
1039	=item L<AnyEvent::DNS>	1155	=item L<AnyEvent::DNS>
1040		1156
1041	Provides rich asynchronous DNS resolver capabilities.	1157	Provides rich asynchronous DNS resolver capabilities.
1042		1158
		1159	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1160
		1161	Implement event-based interfaces to the protocols of the same name (for
		1162	the curious, IGS is the International Go Server and FCP is the Freenet
		1163	Client Protocol).
		1164
		1165	=item L<AnyEvent::Handle::UDP>
		1166
		1167	Here be danger!
		1168
		1169	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1170	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1171	its use of a stream-based API with a protocol that isn't streamable, that
		1172	the only way to improve it is to delete it.
		1173
		1174	It features data corruption (but typically only under load) and general
		1175	confusion. On top, the author is not only clueless about UDP but also
		1176	fact-resistant - some gems of his understanding: "connect doesn't work
		1177	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1178	packets", "I don't need to implement proper error checking as UDP doesn't
		1179	support error checking" and so on - he doesn't even understand what's
		1180	wrong with his module when it is explained to him.
		1181
1043	=item L<AnyEvent::HTTP>	1182	=item L<AnyEvent::DBI>
1044		1183
1045	A simple-to-use HTTP library that is capable of making a lot of concurrent	1184	Executes L<DBI> requests asynchronously in a proxy process for you,
1046	HTTP requests.	1185	notifying you in an event-based way when the operation is finished.
		1186
		1187	=item L<AnyEvent::AIO>
		1188
		1189	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1190	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1191	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1192	file I/O, and much more.
1047		1193
1048	=item L<AnyEvent::HTTPD>	1194	=item L<AnyEvent::HTTPD>
1049		1195
1050	Provides a simple web application server framework.	1196	A simple embedded webserver.
1051		1197
1052	=item L<AnyEvent::FastPing>	1198	=item L<AnyEvent::FastPing>
1053		1199
1054	The fastest ping in the west.	1200	The fastest ping in the west.
1055
1056	=item L<AnyEvent::DBI>
1057
1058	Executes L<DBI> requests asynchronously in a proxy process.
1059
1060	=item L<AnyEvent::AIO>
1061
1062	Truly asynchronous I/O, should be in the toolbox of every event
1063	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1064	together.
1065
1066	=item L<AnyEvent::BDB>
1067
1068	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1069	L<BDB> and AnyEvent together.
1070
1071	=item L<AnyEvent::GPSD>
1072
1073	A non-blocking interface to gpsd, a daemon delivering GPS information.
1074
1075	=item L<AnyEvent::IRC>
1076
1077	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1078
1079	=item L<AnyEvent::XMPP>
1080
1081	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1082	Net::XMPP2>.
1083
1084	=item L<AnyEvent::IGS>
1085
1086	A non-blocking interface to the Internet Go Server protocol (used by
1087	L<App::IGS>).
1088
1089	=item L<Net::FCP>
1090
1091	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1092	of AnyEvent.
1093
1094	=item L<Event::ExecFlow>
1095
1096	High level API for event-based execution flow control.
1097		1201
1098	=item L<Coro>	1202	=item L<Coro>
1099		1203
1100	Has special support for AnyEvent via L<Coro::AnyEvent>.	1204	Has special support for AnyEvent via L<Coro::AnyEvent>.
1101		1205
…		…
1105		1209
1106	package AnyEvent;	1210	package AnyEvent;
1107		1211
1108	# basically a tuned-down version of common::sense	1212	# basically a tuned-down version of common::sense
1109	sub common_sense {	1213	sub common_sense {
1110	# no warnings	1214	# from common:.sense 3.4
1111	${^WARNING_BITS} ^= ${^WARNING_BITS};	1215	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1112	# use strict vars subs	1216	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113	$^H |= 0x00000600;	1217	$^H |= 0x00000600;
1114	}	1218	}
1115		1219
1116	BEGIN { AnyEvent::common_sense }	1220	BEGIN { AnyEvent::common_sense }
1117		1221
1118	use Carp ();	1222	use Carp ();
1119		1223
1120	our $VERSION = 4.92;	1224	our $VERSION = '6.01';
1121	our $MODEL;	1225	our $MODEL;
1122		1226
1123	our $AUTOLOAD;
1124	our @ISA;	1227	our @ISA;
1125		1228
1126	our @REGISTRY;	1229	our @REGISTRY;
1127		1230
1128	our $WIN32;
1129
1130	our $VERBOSE;	1231	our $VERBOSE;
1131		1232
1132	BEGIN {	1233	BEGIN {
1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1234	require "AnyEvent/constants.pl";
		1235
1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1236	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1135		1237
1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1238	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137	if ${^TAINT};	1239	if ${^TAINT};
1138		1240
1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1241	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1140
1141	}	1242	}
1142		1243
1143	our $MAX_SIGNAL_LATENCY = 10;	1244	our $MAX_SIGNAL_LATENCY = 10;
1144		1245
1145	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1246	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
…		…
1149	$PROTOCOL{$_} = ++$idx	1250	$PROTOCOL{$_} = ++$idx
1150	for reverse split /\s*,\s*/,	1251	for reverse split /\s*,\s*/,
1151	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1252	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1152	}	1253	}
1153		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
1154	my @models = (	1295	our @models = (
1155	[EV:: => AnyEvent::Impl::EV:: , 1],	1296	[EV:: => AnyEvent::Impl::EV:: , 1],
1156	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1297	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1157	# everything below here will not (normally) be autoprobed	1298	# everything below here will not (normally) be autoprobed
1158	# as the pureperl backend should work everywhere	1299	# as the pure perl backend should work everywhere
1159	# and is usually faster	1300	# and is usually faster
1160	[Event:: => AnyEvent::Impl::Event::, 1],	1301	[Event:: => AnyEvent::Impl::Event::, 1],
1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1302	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1303	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1304	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1305	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1306	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1307	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1167	[Wx:: => AnyEvent::Impl::POE::],	1308	[Wx:: => AnyEvent::Impl::POE::],
1168	[Prima:: => AnyEvent::Impl::POE::],	1309	[Prima:: => AnyEvent::Impl::POE::],
1169	# IO::Async is just too broken - we would need workarounds for its	1310	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1170	# byzantine signal and broken child handling, among others.	1311	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1171	# IO::Async is rather hard to detect, as it doesn't have any	1312	[FLTK:: => AnyEvent::Impl::FLTK2::],
1172	# obvious default class.
1173	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1177	);	1313	);
1178		1314
1179	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.
1180	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);
1181		1339
1182	our @post_detect;
1183
1184	sub post_detect(&) {	1340	sub detect() {
1185	my ($cb) = @_;	1341	return $MODEL if $MODEL; # some programs keep references to detect
1186		1342
1187	if ($MODEL) {	1343	local $!; # for good measure
1188	$cb->();	1344	local $SIG{__DIE__}; # we use eval
1189		1345
1190	undef	1346	# free some memory
		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;
		1355
		1356	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
		1357	my $model = $1;
		1358	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
		1359	if (eval "require $model") {
		1360	$MODEL = $model;
		1361	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
		1362	if $VERBOSE >= 7;
1191	} else {	1363	} else {
1192	push @post_detect, $cb;	1364	AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1193		1365	}
1194	defined wantarray
1195	? bless \$cb, "AnyEvent::Util::postdetect"
1196	: ()
1197	}	1366	}
1198	}
1199		1367
1200	sub AnyEvent::Util::postdetect::DESTROY {	1368	# check for already loaded models
1201	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1202	}
1203
1204	sub detect() {
1205	unless ($MODEL) {	1369	unless ($MODEL) {
1206	local $SIG{__DIE__};	1370	for (@REGISTRY, @models) {
1207		1371	my ($package, $model) = @$_;
1208	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1372	if (${"$package\::VERSION"} > 0) {
1209	my $model = "AnyEvent::Impl::$1";
1210	if (eval "require $model") {	1373	if (eval "require $model") {
1211	$MODEL = $model;	1374	$MODEL = $model;
1212	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1375	AnyEvent::log 7 => "autodetected model '$model', using it."
1213	} else {	1376	if $VERBOSE >= 7;
1214	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1377	last;
		1378	}
1215	}	1379	}
1216	}	1380	}
1217		1381
1218	# check for already loaded models
1219	unless ($MODEL) {	1382	unless ($MODEL) {
		1383	# try to autoload a model
1220	for (@REGISTRY, @models) {	1384	for (@REGISTRY, @models) {
1221	my ($package, $model) = @$_;	1385	my ($package, $model, $autoload) = @$_;
		1386	if (
		1387	$autoload
		1388	and eval "require $package"
1222	if (${"$package\::VERSION"} > 0) {	1389	and ${"$package\::VERSION"} > 0
1223	if (eval "require $model") {	1390	and eval "require $model"
		1391	) {
1224	$MODEL = $model;	1392	$MODEL = $model;
1225	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1393	AnyEvent::log 7 => "autoloaded model '$model', using it."
		1394	if $VERBOSE >= 7;
1226	last;	1395	last;
1227	}
1228	}	1396	}
1229	}	1397	}
1230		1398
1231	unless ($MODEL) {
1232	# try to autoload a model
1233	for (@REGISTRY, @models) {
1234	my ($package, $model, $autoload) = @$_;
1235	if (
1236	$autoload
1237	and eval "require $package"
1238	and ${"$package\::VERSION"} > 0
1239	and eval "require $model"
1240	) {
1241	$MODEL = $model;
1242	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1243	last;
1244	}
1245	}
1246
1247	$MODEL	1399	$MODEL
1248	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?";
1249	}
1250	}	1401	}
1251
1252	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1253
1254	unshift @ISA, $MODEL;
1255
1256	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1257
1258	(shift @post_detect)->() while @post_detect;
1259	}	1402	}
1260		1403
		1404	# free memory only needed for probing
		1405	undef @models;
		1406	undef @REGISTRY;
		1407
		1408	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1409
		1410	# now nuke some methods that are overridden by the backend.
		1411	# SUPER usage is not allowed in these.
		1412	for (qw(time signal child idle)) {
		1413	undef &{"AnyEvent::Base::$_"}
		1414	if defined &{"$MODEL\::$_"};
		1415	}
		1416
		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
		1443
		1444	(shift @post_detect)->() while @post_detect;
		1445	undef @post_detect;
		1446
		1447	*post_detect = sub(&) {
		1448	shift->();
		1449
		1450	undef
		1451	};
		1452
1261	$MODEL	1453	$MODEL
1262	}	1454	}
1263		1455
1264	sub AUTOLOAD {	1456	for my $name (@methods) {
1265	(my $func = $AUTOLOAD) =~ s/.*://;	1457	*$name = sub {
1266		1458	detect;
1267	$method{$func}	1459	# we use goto because
1268	or Carp::croak "$func: not a valid method for AnyEvent objects";	1460	# a) it makes the thunk more transparent
1269		1461	# b) it allows us to delete the thunk later
1270	detect unless $MODEL;	1462	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1271		1463	};
1272	my $class = shift;
1273	$class->$func (@_);
1274	}	1464	}
1275		1465
1276	# 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
1277	# to support binding more than one watcher per filehandle (they usually	1467	# to support binding more than one watcher per filehandle (they usually
1278	# 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).
…		…
1292		1482
1293	=head1 SIMPLIFIED AE API	1483	=head1 SIMPLIFIED AE API
1294		1484
1295	Starting with version 5.0, AnyEvent officially supports a second, much	1485	Starting with version 5.0, AnyEvent officially supports a second, much
1296	simpler, API that is designed to reduce the calling, typing and memory	1486	simpler, API that is designed to reduce the calling, typing and memory
1297	overhead.	1487	overhead by using function call syntax and a fixed number of parameters.
1298		1488
1299	See the L<AE> manpage for details.	1489	See the L<AE> manpage for details.
1300		1490
1301	=cut	1491	=cut
1302		1492
1303	package AE;	1493	package AE;
1304		1494
1305	our $VERSION = $AnyEvent::VERSION;	1495	our $VERSION = $AnyEvent::VERSION;
1306		1496
		1497	sub _reset() {
		1498	eval q{
		1499	# fall back to the main API by default - backends and AnyEvent::Base
		1500	# implementations can overwrite these.
		1501
1307	sub io($$$) {	1502	sub io($$$) {
1308	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1503	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1309	}	1504	}
1310		1505
1311	sub timer($$$) {	1506	sub timer($$$) {
1312	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1507	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1313	}	1508	}
1314		1509
1315	sub signal($$) {	1510	sub signal($$) {
1316	AnyEvent->signal (signal => $_[0], cb => $_[1])	1511	AnyEvent->signal (signal => $_[0], cb => $_[1])
1317	}	1512	}
1318		1513
1319	sub child($$) {	1514	sub child($$) {
1320	AnyEvent->child (pid => $_[0], cb => $_[1])	1515	AnyEvent->child (pid => $_[0], cb => $_[1])
1321	}	1516	}
1322		1517
1323	sub idle($) {	1518	sub idle($) {
1324	AnyEvent->idle (cb => $_[0])	1519	AnyEvent->idle (cb => $_[0]);
1325	}	1520	}
1326		1521
1327	sub cv(;&) {	1522	sub cv(;&) {
1328	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1523	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1329	}	1524	}
1330		1525
1331	sub now() {	1526	sub now() {
1332	AnyEvent->now	1527	AnyEvent->now
1333	}	1528	}
1334		1529
1335	sub now_update() {	1530	sub now_update() {
1336	AnyEvent->now_update	1531	AnyEvent->now_update
1337	}	1532	}
1338		1533
1339	sub time() {	1534	sub time() {
1340	AnyEvent->time	1535	AnyEvent->time
		1536	}
		1537
		1538	*postpone = \&AnyEvent::postpone;
		1539	*log = \&AnyEvent::log;
		1540	};
		1541	die if $@;
1341	}	1542	}
		1543
		1544	BEGIN { _reset }
1342		1545
1343	package AnyEvent::Base;	1546	package AnyEvent::Base;
1344		1547
1345	# default implementations for many methods	1548	# default implementations for many methods
1346		1549
1347	sub _time {	1550	sub time {
		1551	eval q{ # poor man's autoloading {}
1348	# probe for availability of Time::HiRes	1552	# probe for availability of Time::HiRes
1349	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1553	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1350	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 () };
1351	*_time = \&Time::HiRes::time;	1557	*AE::time = \& Time::HiRes::time ;
1352	# if (eval "use POSIX (); (POSIX::times())...	1558	# if (eval "use POSIX (); (POSIX::times())...
1353	} else {	1559	} else {
1354	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!";
1355	*_time = sub { time }; # epic fail	1561	*time = sub { CORE::time };
		1562	*AE::time = sub (){ CORE::time };
		1563	}
		1564
		1565	*now = \&time;
1356	}	1566	};
		1567	die if $@;
1357		1568
1358	&_time	1569	&time
1359	}	1570	}
1360		1571
1361	sub time { _time }	1572	*now = \&time;
1362	sub now { _time }
1363	sub now_update { }	1573	sub now_update { }
1364		1574
		1575	sub _poll {
		1576	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1577	}
		1578
1365	# default implementation for ->condvar	1579	# default implementation for ->condvar
		1580	# in fact, the default should not be overwritten
1366		1581
1367	sub condvar {	1582	sub condvar {
		1583	eval q{ # poor man's autoloading {}
		1584	*condvar = sub {
1368	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1585	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1586	};
		1587
		1588	*AE::cv = sub (;&) {
		1589	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1590	};
		1591	};
		1592	die if $@;
		1593
		1594	&condvar
1369	}	1595	}
1370		1596
1371	# default implementation for ->signal	1597	# default implementation for ->signal
1372		1598
1373	our $HAVE_ASYNC_INTERRUPT;	1599	our $HAVE_ASYNC_INTERRUPT;
1374		1600
1375	sub _have_async_interrupt() {	1601	sub _have_async_interrupt() {
1376	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1602	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1377	&& eval "use Async::Interrupt 1.0 (); 1")	1603	&& eval "use Async::Interrupt 1.02 (); 1")
1378	unless defined $HAVE_ASYNC_INTERRUPT;	1604	unless defined $HAVE_ASYNC_INTERRUPT;
1379		1605
1380	$HAVE_ASYNC_INTERRUPT	1606	$HAVE_ASYNC_INTERRUPT
1381	}	1607	}
1382		1608
1383	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1609	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1384	our (%SIG_ASY, %SIG_ASY_W);	1610	our (%SIG_ASY, %SIG_ASY_W);
1385	our ($SIG_COUNT, $SIG_TW);	1611	our ($SIG_COUNT, $SIG_TW);
1386		1612
1387	sub _signal_exec {
1388	$HAVE_ASYNC_INTERRUPT
1389	? $SIGPIPE_R->drain
1390	: sysread $SIGPIPE_R, my $dummy, 9;
1391
1392	while (%SIG_EV) {
1393	for (keys %SIG_EV) {
1394	delete $SIG_EV{$_};
1395	$_->() for values %{ $SIG_CB{$_} || {} };
1396	}
1397	}
1398	}
1399
1400	# install a dummy wakeup watcher to reduce signal catching latency	1613	# install a dummy wakeup watcher to reduce signal catching latency
		1614	# used by Impls
1401	sub _sig_add() {	1615	sub _sig_add() {
1402	unless ($SIG_COUNT++) {	1616	unless ($SIG_COUNT++) {
1403	# try to align timer on a full-second boundary, if possible	1617	# try to align timer on a full-second boundary, if possible
1404	my $NOW = AE::now;	1618	my $NOW = AE::now;
1405		1619
…		…
1415	undef $SIG_TW	1629	undef $SIG_TW
1416	unless --$SIG_COUNT;	1630	unless --$SIG_COUNT;
1417	}	1631	}
1418		1632
1419	our $_sig_name_init; $_sig_name_init = sub {	1633	our $_sig_name_init; $_sig_name_init = sub {
1420	eval q{ # poor man's autoloading	1634	eval q{ # poor man's autoloading {}
1421	undef $_sig_name_init;	1635	undef $_sig_name_init;
1422		1636
1423	if (_have_async_interrupt) {	1637	if (_have_async_interrupt) {
1424	*sig2num = \&Async::Interrupt::sig2num;	1638	*sig2num = \&Async::Interrupt::sig2num;
1425	*sig2name = \&Async::Interrupt::sig2name;	1639	*sig2name = \&Async::Interrupt::sig2name;
…		…
1449		1663
1450	sub signal {	1664	sub signal {
1451	eval q{ # poor man's autoloading {}	1665	eval q{ # poor man's autoloading {}
1452	# probe for availability of Async::Interrupt	1666	# probe for availability of Async::Interrupt
1453	if (_have_async_interrupt) {	1667	if (_have_async_interrupt) {
1454	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;
1455		1670
1456	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1671	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1457	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1672	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1458		1673
1459	} else {	1674	} else {
1460	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."
1461		1676	if $AnyEvent::VERBOSE >= 8;
1462	require Fcntl;
1463		1677
1464	if (AnyEvent::WIN32) {	1678	if (AnyEvent::WIN32) {
1465	require AnyEvent::Util;	1679	require AnyEvent::Util;
1466		1680
1467	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1681	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1468	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1682	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1683	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1470	} else {	1684	} else {
1471	pipe $SIGPIPE_R, $SIGPIPE_W;	1685	pipe $SIGPIPE_R, $SIGPIPE_W;
1472	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1686	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1473	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1687	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1474		1688
1475	# not strictly required, as $^F is normally 2, but let's make sure...	1689	# not strictly required, as $^F is normally 2, but let's make sure...
1476	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1690	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1477	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1691	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1478	}	1692	}
1479		1693
1480	$SIGPIPE_R	1694	$SIGPIPE_R
1481	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1695	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1482		1696
1483	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1697	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1484	}	1698	}
1485		1699
1486	*signal = sub {	1700	*signal = $HAVE_ASYNC_INTERRUPT
		1701	? sub {
1487	my (undef, %arg) = @_;	1702	my (undef, %arg) = @_;
1488		1703
1489	my $signal = uc $arg{signal}
1490	or Carp::croak "required option 'signal' is missing";
1491
1492	if ($HAVE_ASYNC_INTERRUPT) {
1493	# async::interrupt	1704	# async::interrupt
1494
1495	$signal = sig2num $signal;	1705	my $signal = sig2num $arg{signal};
1496	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1706	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1497		1707
1498	$SIG_ASY{$signal} ||= new Async::Interrupt	1708	$SIG_ASY{$signal} ||= new Async::Interrupt
1499	cb => sub { undef $SIG_EV{$signal} },	1709	cb => sub { undef $SIG_EV{$signal} },
1500	signal => $signal,	1710	signal => $signal,
1501	pipe => [$SIGPIPE_R->filenos],	1711	pipe => [$SIGPIPE_R->filenos],
1502	pipe_autodrain => 0,	1712	pipe_autodrain => 0,
1503	;	1713	;
1504		1714
1505	} else {	1715	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1716	}
		1717	: sub {
		1718	my (undef, %arg) = @_;
		1719
1506	# pure perl	1720	# pure perl
1507
1508	# AE::Util has been loaded in signal
1509	$signal = sig2name $signal;	1721	my $signal = sig2name $arg{signal};
1510	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1722	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1511		1723
1512	$SIG{$signal} ||= sub {	1724	$SIG{$signal} ||= sub {
1513	local $!;	1725	local $!;
1514	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1726	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1515	undef $SIG_EV{$signal};	1727	undef $SIG_EV{$signal};
1516	};	1728	};
1517		1729
1518	# can't do signal processing without introducing races in pure perl,	1730	# can't do signal processing without introducing races in pure perl,
1519	# so limit the signal latency.	1731	# so limit the signal latency.
1520	_sig_add;	1732	_sig_add;
1521	}
1522		1733
1523	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1734	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1735	}
1524	};	1736	;
1525		1737
1526	*AnyEvent::Base::signal::DESTROY = sub {	1738	*AnyEvent::Base::signal::DESTROY = sub {
1527	my ($signal, $cb) = @{$_[0]};	1739	my ($signal, $cb) = @{$_[0]};
1528		1740
1529	_sig_del;	1741	_sig_del;
…		…
1536	# print weird messages, or just unconditionally exit	1748	# print weird messages, or just unconditionally exit
1537	# instead of getting the default action.	1749	# instead of getting the default action.
1538	undef $SIG{$signal}	1750	undef $SIG{$signal}
1539	unless keys %{ $SIG_CB{$signal} };	1751	unless keys %{ $SIG_CB{$signal} };
1540	};	1752	};
		1753
		1754	*_signal_exec = sub {
		1755	$HAVE_ASYNC_INTERRUPT
		1756	? $SIGPIPE_R->drain
		1757	: sysread $SIGPIPE_R, (my $dummy), 9;
		1758
		1759	while (%SIG_EV) {
		1760	for (keys %SIG_EV) {
		1761	delete $SIG_EV{$_};
		1762	&$_ for values %{ $SIG_CB{$_} || {} };
		1763	}
		1764	}
		1765	};
1541	};	1766	};
1542	die if $@;	1767	die if $@;
		1768
1543	&signal	1769	&signal
1544	}	1770	}
1545		1771
1546	# default implementation for ->child	1772	# default implementation for ->child
1547		1773
1548	our %PID_CB;	1774	our %PID_CB;
1549	our $CHLD_W;	1775	our $CHLD_W;
1550	our $CHLD_DELAY_W;	1776	our $CHLD_DELAY_W;
1551	our $WNOHANG;
1552		1777
		1778	# used by many Impl's
1553	sub _emit_childstatus($$) {	1779	sub _emit_childstatus($$) {
1554	my (undef, $rpid, $rstatus) = @_;	1780	my (undef, $rpid, $rstatus) = @_;
1555		1781
1556	$_->($rpid, $rstatus)	1782	$_->($rpid, $rstatus)
1557	for values %{ $PID_CB{$rpid} || {} },	1783	for values %{ $PID_CB{$rpid} || {} },
1558	values %{ $PID_CB{0} || {} };	1784	values %{ $PID_CB{0} || {} };
1559	}	1785	}
1560		1786
1561	sub _sigchld {
1562	my $pid;
1563
1564	AnyEvent->_emit_childstatus ($pid, $?)
1565	while ($pid = waitpid -1, $WNOHANG) > 0;
1566	}
1567
1568	sub child {	1787	sub child {
		1788	eval q{ # poor man's autoloading {}
		1789	*_sigchld = sub {
		1790	my $pid;
		1791
		1792	AnyEvent->_emit_childstatus ($pid, $?)
		1793	while ($pid = waitpid -1, WNOHANG) > 0;
		1794	};
		1795
		1796	*child = sub {
1569	my (undef, %arg) = @_;	1797	my (undef, %arg) = @_;
1570		1798
1571	defined (my $pid = $arg{pid} + 0)	1799	my $pid = $arg{pid};
1572	or Carp::croak "required option 'pid' is missing";	1800	my $cb = $arg{cb};
1573		1801
1574	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1802	$PID_CB{$pid}{$cb+0} = $cb;
1575		1803
1576	# WNOHANG is almost cetrainly 1 everywhere
1577	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1578	? 1
1579	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1580
1581	unless ($CHLD_W) {	1804	unless ($CHLD_W) {
1582	$CHLD_W = AE::signal CHLD => \&_sigchld;	1805	$CHLD_W = AE::signal CHLD => \&_sigchld;
1583	# 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
1584	&_sigchld;	1807	&_sigchld;
1585	}	1808	}
1586		1809
1587	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1810	bless [$pid, $cb+0], "AnyEvent::Base::child"
1588	}	1811	};
1589		1812
1590	sub AnyEvent::Base::child::DESTROY {	1813	*AnyEvent::Base::child::DESTROY = sub {
1591	my ($pid, $cb) = @{$_[0]};	1814	my ($pid, $icb) = @{$_[0]};
1592		1815
1593	delete $PID_CB{$pid}{$cb};	1816	delete $PID_CB{$pid}{$icb};
1594	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1817	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1595		1818
1596	undef $CHLD_W unless keys %PID_CB;	1819	undef $CHLD_W unless keys %PID_CB;
		1820	};
		1821	};
		1822	die if $@;
		1823
		1824	&child
1597	}	1825	}
1598		1826
1599	# idle emulation is done by simply using a timer, regardless	1827	# idle emulation is done by simply using a timer, regardless
1600	# of whether the process is idle or not, and not letting	1828	# of whether the process is idle or not, and not letting
1601	# the callback use more than 50% of the time.	1829	# the callback use more than 50% of the time.
1602	sub idle {	1830	sub idle {
		1831	eval q{ # poor man's autoloading {}
		1832	*idle = sub {
1603	my (undef, %arg) = @_;	1833	my (undef, %arg) = @_;
1604		1834
1605	my ($cb, $w, $rcb) = $arg{cb};	1835	my ($cb, $w, $rcb) = $arg{cb};
1606		1836
1607	$rcb = sub {	1837	$rcb = sub {
1608	if ($cb) {	1838	if ($cb) {
1609	$w = _time;	1839	$w = AE::time;
1610	&$cb;	1840	&$cb;
1611	$w = _time - $w;	1841	$w = AE::time - $w;
1612		1842
1613	# 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,
1614	# within some limits	1844	# within some limits
1615	$w = 0.0001 if $w < 0.0001;	1845	$w = 0.0001 if $w < 0.0001;
1616	$w = 5 if $w > 5;	1846	$w = 5 if $w > 5;
1617		1847
1618	$w = AE::timer $w, 0, $rcb;	1848	$w = AE::timer $w, 0, $rcb;
1619	} else {	1849	} else {
1620	# clean up...	1850	# clean up...
1621	undef $w;	1851	undef $w;
1622	undef $rcb;	1852	undef $rcb;
		1853	}
		1854	};
		1855
		1856	$w = AE::timer 0.05, 0, $rcb;
		1857
		1858	bless \\$cb, "AnyEvent::Base::idle"
1623	}	1859	};
		1860
		1861	*AnyEvent::Base::idle::DESTROY = sub {
		1862	undef $${$_[0]};
		1863	};
1624	};	1864	};
		1865	die if $@;
1625		1866
1626	$w = AE::timer 0.05, 0, $rcb;	1867	&idle
1627
1628	bless \\$cb, "AnyEvent::Base::idle"
1629	}
1630
1631	sub AnyEvent::Base::idle::DESTROY {
1632	undef $${$_[0]};
1633	}	1868	}
1634		1869
1635	package AnyEvent::CondVar;	1870	package AnyEvent::CondVar;
1636		1871
1637	our @ISA = AnyEvent::CondVar::Base::;	1872	our @ISA = AnyEvent::CondVar::Base::;
		1873
		1874	# only to be used for subclassing
		1875	sub new {
		1876	my $class = shift;
		1877	bless AnyEvent->condvar (@_), $class
		1878	}
1638		1879
1639	package AnyEvent::CondVar::Base;	1880	package AnyEvent::CondVar::Base;
1640		1881
1641	#use overload	1882	#use overload
1642	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1883	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
…		…
1652		1893
1653	sub _send {	1894	sub _send {
1654	# nop	1895	# nop
1655	}	1896	}
1656		1897
		1898	sub _wait {
		1899	AnyEvent->_poll until $_[0]{_ae_sent};
		1900	}
		1901
1657	sub send {	1902	sub send {
1658	my $cv = shift;	1903	my $cv = shift;
1659	$cv->{_ae_sent} = [@_];	1904	$cv->{_ae_sent} = [@_];
1660	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1905	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1661	$cv->_send;	1906	$cv->_send;
…		…
1668		1913
1669	sub ready {	1914	sub ready {
1670	$_[0]{_ae_sent}	1915	$_[0]{_ae_sent}
1671	}	1916	}
1672		1917
1673	sub _wait {
1674	$WAITING
1675	and !$_[0]{_ae_sent}
1676	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1677
1678	local $WAITING = 1;
1679	AnyEvent->one_event while !$_[0]{_ae_sent};
1680	}
1681
1682	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;
1683	$_[0]->_wait;	1924	$_[0]->_wait;
		1925	}
1684		1926
1685	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1927	$_[0]{_ae_croak}
1686	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]
1687	}	1933	}
1688		1934
1689	sub cb {	1935	sub cb {
1690	my $cv = shift;	1936	my $cv = shift;
1691		1937
…		…
1707	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1953	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1708	}	1954	}
1709		1955
1710	# undocumented/compatibility with pre-3.4	1956	# undocumented/compatibility with pre-3.4
1711	*broadcast = \&send;	1957	*broadcast = \&send;
1712	*wait = \&_wait;	1958	*wait = \&recv;
1713		1959
1714	=head1 ERROR AND EXCEPTION HANDLING	1960	=head1 ERROR AND EXCEPTION HANDLING
1715		1961
1716	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
1717	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
…		…
1744		1990
1745	By default, AnyEvent will be completely silent except in fatal	1991	By default, AnyEvent will be completely silent except in fatal
1746	conditions. You can set this environment variable to make AnyEvent more	1992	conditions. You can set this environment variable to make AnyEvent more
1747	talkative.	1993	talkative.
1748		1994
1749	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
1750	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
1751	C<PERL_ANYEVENT_MODEL>.	1997	C<PERL_ANYEVENT_MODEL>.
1752		1998
1753	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
1754	model it chooses.	2000	model it chooses.
1755		2001
1756	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
1757	which optional modules it loads and how it implements certain features.	2003	which optional modules it loads and how it implements certain features.
1758		2004
…		…
1764	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,
1765	it will croak.	2011	it will croak.
1766		2012
1767	In other words, enables "strict" mode.	2013	In other words, enables "strict" mode.
1768		2014
1769	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>
1770	>>, it is definitely recommended to keep it off in production. Keeping	2016	>>, it is definitely recommended to keep it off in production. Keeping
1771	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2017	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1772	can be very useful, however.	2018	can be very useful, however.
1773		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
1774	=item C<PERL_ANYEVENT_MODEL>	2042	=item C<PERL_ANYEVENT_MODEL>
1775		2043
1776	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
1777	auto detection and -probing kicks in. It must be a string consisting	2045	auto detection and -probing kicks in.
1778	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
1779	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
1780	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
1781	auto detection and -probing.	2051	auto detection and -probing.
1782		2052
1783	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).
1784		2056
1785	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
1786	could start your program like this:	2058	could start your program like this:
1787		2059
1788	PERL_ANYEVENT_MODEL=Perl perl ...	2060	PERL_ANYEVENT_MODEL=Perl perl ...
1789		2061
1790	=item C<PERL_ANYEVENT_PROTOCOLS>	2062	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1911	warn "read: $input\n"; # output what has been read	2183	warn "read: $input\n"; # output what has been read
1912	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2184	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1913	},	2185	},
1914	);	2186	);
1915		2187
1916	my $time_watcher; # can only be used once
1917
1918	sub new_timer {
1919	$timer = AnyEvent->timer (after => 1, cb => sub {	2188	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1920	warn "timeout\n"; # print 'timeout' about every second	2189	warn "timeout\n"; # print 'timeout' at most every second
1921	&new_timer; # and restart the time
1922	});	2190	});
1923	}
1924
1925	new_timer; # create first timer
1926		2191
1927	$cv->recv; # wait until user enters /^q/i	2192	$cv->recv; # wait until user enters /^q/i
1928		2193
1929	=head1 REAL-WORLD EXAMPLE	2194	=head1 REAL-WORLD EXAMPLE
1930		2195
…		…
2003		2268
2004	The actual code goes further and collects all errors (C<die>s, exceptions)	2269	The actual code goes further and collects all errors (C<die>s, exceptions)
2005	that occurred during request processing. The C<result> method detects	2270	that occurred during request processing. The C<result> method detects
2006	whether an exception as thrown (it is stored inside the $txn object)	2271	whether an exception as thrown (it is stored inside the $txn object)
2007	and just throws the exception, which means connection errors and other	2272	and just throws the exception, which means connection errors and other
2008	problems get reported tot he code that tries to use the result, not in a	2273	problems get reported to the code that tries to use the result, not in a
2009	random callback.	2274	random callback.
2010		2275
2011	All of this enables the following usage styles:	2276	All of this enables the following usage styles:
2012		2277
2013	1. Blocking:	2278	1. Blocking:
…		…
2187	(even when used without AnyEvent), but most event loops have acceptable	2452	(even when used without AnyEvent), but most event loops have acceptable
2188	performance with or without AnyEvent.	2453	performance with or without AnyEvent.
2189		2454
2190	=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
2191	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
2192	adds AnyEvent significant overhead.	2457	does AnyEvent add significant overhead.
2193		2458
2194	=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
2195	reasonable memory usage.	2460	reasonable memory usage.
2196		2461
2197	=back	2462	=back
…		…
2374	As you can see, the AnyEvent + EV combination even beats the	2639	As you can see, the AnyEvent + EV combination even beats the
2375	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2640	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2376	backend easily beats IO::Lambda and POE.	2641	backend easily beats IO::Lambda and POE.
2377		2642
2378	And even the 100% non-blocking version written using the high-level (and	2643	And even the 100% non-blocking version written using the high-level (and
2379	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2644	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2380	large margin, even though it does all of DNS, tcp-connect and socket I/O	2645	higher level ("unoptimised") abstractions by a large margin, even though
2381	in a non-blocking way.	2646	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2382		2647
2383	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2648	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2384	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2649	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2385	part of the IO::lambda distribution and were used without any changes.	2650	part of the IO::Lambda distribution and were used without any changes.
2386		2651
2387		2652
2388	=head1 SIGNALS	2653	=head1 SIGNALS
2389		2654
2390	AnyEvent currently installs handlers for these signals:	2655	AnyEvent currently installs handlers for these signals:
…		…
2427	unless defined $SIG{PIPE};	2692	unless defined $SIG{PIPE};
2428		2693
2429	=head1 RECOMMENDED/OPTIONAL MODULES	2694	=head1 RECOMMENDED/OPTIONAL MODULES
2430		2695
2431	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
2432	it's built-in modules) are required to use it.	2697	its built-in modules) are required to use it.
2433		2698
2434	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
2435	modules if they are installed.	2700	modules if they are installed.
2436		2701
2437	This section epxlains which additional modules will be used, and how they	2702	This section explains which additional modules will be used, and how they
2438	affect AnyEvent's operetion.	2703	affect AnyEvent's operation.
2439		2704
2440	=over 4	2705	=over 4
2441		2706
2442	=item L<Async::Interrupt>	2707	=item L<Async::Interrupt>
2443		2708
…		…
2448	catch the signals) with some delay (default is 10 seconds, look for	2713	catch the signals) with some delay (default is 10 seconds, look for
2449	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2714	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2450		2715
2451	If this module is available, then it will be used to implement signal	2716	If this module is available, then it will be used to implement signal
2452	catching, which means that signals will not be delayed, and the event loop	2717	catching, which means that signals will not be delayed, and the event loop
2453	will not be interrupted regularly, which is more efficient (And good for	2718	will not be interrupted regularly, which is more efficient (and good for
2454	battery life on laptops).	2719	battery life on laptops).
2455		2720
2456	This affects not just the pure-perl event loop, but also other event loops	2721	This affects not just the pure-perl event loop, but also other event loops
2457	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2722	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2458		2723
…		…
2470	automatic timer adjustments even when no monotonic clock is available,	2735	automatic timer adjustments even when no monotonic clock is available,
2471	can take avdantage of advanced kernel interfaces such as C<epoll> and	2736	can take avdantage of advanced kernel interfaces such as C<epoll> and
2472	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2737	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2473	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2738	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2474		2739
		2740	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2741	then this module will do nothing for you.
		2742
2475	=item L<Guard>	2743	=item L<Guard>
2476		2744
2477	The guard module, when used, will be used to implement	2745	The guard module, when used, will be used to implement
2478	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2746	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2479	lot less memory), but otherwise doesn't affect guard operation much. It is	2747	lot less memory), but otherwise doesn't affect guard operation much. It is
2480	purely used for performance.	2748	purely used for performance.
2481		2749
2482	=item L<JSON> and L<JSON::XS>	2750	=item L<JSON> and L<JSON::XS>
2483		2751
2484	This module is required when you want to read or write JSON data via	2752	One of these modules is required when you want to read or write JSON data
2485	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2753	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2486	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2754	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2487
2488	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2489	installed.
2490		2755
2491	=item L<Net::SSLeay>	2756	=item L<Net::SSLeay>
2492		2757
2493	Implementing TLS/SSL in Perl is certainly interesting, but not very	2758	Implementing TLS/SSL in Perl is certainly interesting, but not very
2494	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2759	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2495	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.
2496		2761
2497	=item L<Time::HiRes>	2762	=item L<Time::HiRes>
2498		2763
2499	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
2500	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
2501	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
2502	try to use a monotonic clock for timing stability.	2767	try to use a monotonic clock for timing stability.
2503		2768
2504	=back	2769	=back
2505		2770
2506		2771
2507	=head1 FORK	2772	=head1 FORK
2508		2773
2509	Most event libraries are not fork-safe. The ones who are usually are	2774	Most event libraries are not fork-safe. The ones who are usually are
2510	because they rely on inefficient but fork-safe C<select> or C<poll>	2775	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2511	calls. Only L<EV> is fully fork-aware.	2776	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2777	are usually badly thought-out hacks that are incompatible with fork in
		2778	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2779	continue event-processing in both parent and child (or both, if you know
		2780	what you are doing).
		2781
		2782	This means that, in general, you cannot fork and do event processing in
		2783	the child if the event library was initialised before the fork (which
		2784	usually happens when the first AnyEvent watcher is created, or the library
		2785	is loaded).
2512		2786
2513	If you have to fork, you must either do so I<before> creating your first	2787	If you have to fork, you must either do so I<before> creating your first
2514	watcher OR you must not use AnyEvent at all in the child OR you must do	2788	watcher OR you must not use AnyEvent at all in the child OR you must do
2515	something completely out of the scope of AnyEvent.	2789	something completely out of the scope of AnyEvent.
		2790
		2791	The problem of doing event processing in the parent I<and> the child
		2792	is much more complicated: even for backends that I<are> fork-aware or
		2793	fork-safe, their behaviour is not usually what you want: fork clones all
		2794	watchers, that means all timers, I/O watchers etc. are active in both
		2795	parent and child, which is almost never what you want. USing C<exec>
		2796	to start worker children from some kind of manage rprocess is usually
		2797	preferred, because it is much easier and cleaner, at the expense of having
		2798	to have another binary.
2516		2799
2517		2800
2518	=head1 SECURITY CONSIDERATIONS	2801	=head1 SECURITY CONSIDERATIONS
2519		2802
2520	AnyEvent can be forced to load any event model via	2803	AnyEvent can be forced to load any event model via
…		…
2550	pronounced).	2833	pronounced).
2551		2834
2552		2835
2553	=head1 SEE ALSO	2836	=head1 SEE ALSO
2554		2837
2555	Utility functions: L<AnyEvent::Util>.	2838	Tutorial/Introduction: L<AnyEvent::Intro>.
2556		2839
2557	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2840	FAQ: L<AnyEvent::FAQ>.
2558	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>.
2559		2851
2560	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2852	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2561	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>,
2562	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2854	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2563	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>.
2564		2857
2565	Non-blocking file handles, sockets, TCP clients and	2858	Non-blocking handles, pipes, stream sockets, TCP clients and
2566	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2859	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2567		2860
2568	Asynchronous DNS: L<AnyEvent::DNS>.	2861	Asynchronous DNS: L<AnyEvent::DNS>.
2569		2862
2570	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2863	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2571	L<Coro::Event>,
2572		2864
2573	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2865	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2574	L<AnyEvent::HTTP>.	2866	L<AnyEvent::HTTP>.
2575		2867
2576		2868
2577	=head1 AUTHOR	2869	=head1 AUTHOR
2578		2870

Diff Legend

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