ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.269 by root, Fri Jul 31 20:16:29 2009 UTC vs.
Revision 1.352 by root, Thu Aug 4 09:14:01 2011 UTC

…		…
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18		21
19	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21		24
22	# POSIX signal	25	# POSIX signal
…		…
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
…		…
806	=over 4	855	=over 4
807		856
808	=item Backends that are autoprobed when no other event loop can be found.	857	=item Backends that are autoprobed when no other event loop can be found.
809		858
810	EV is the preferred backend when no other event loop seems to be in	859	EV is the preferred backend when no other event loop seems to be in
811	use. If EV is not installed, then AnyEvent will try Event, and, failing	860	use. If EV is not installed, then AnyEvent will fall back to its own
812	that, will fall back to its own pure-perl implementation, which is	861	pure-perl implementation, which is available everywhere as it comes with
813	available everywhere as it comes with 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::Event based on Event, very stable, few glitches.
817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
818		866
819	=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.
820		868
821	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
822	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
823	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
824	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
825	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.
826		874
		875	AnyEvent::Impl::Event based on Event, very stable, few glitches.
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::FLTK based on FLTK.
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.
894		938
895	If you need to do some initialisation before AnyEvent watchers are	939	If you need to do some initialisation before AnyEvent watchers are
896	created, use C<post_detect>.	940	created, use C<post_detect>.
897		941
898	=item $guard = AnyEvent::post_detect { BLOCK }	942	=item $guard = AnyEvent::post_detect { BLOCK }
899		943
900	Arranges for the code block to be executed as soon as the event model is	944	Arranges for the code block to be executed as soon as the event model is
901	autodetected (or immediately if this has already happened).	945	autodetected (or immediately if that has already happened).
902		946
903	The block will be executed I<after> the actual backend has been detected	947	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	948	(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	949	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	950	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
915	that automatically removes the callback again when it is destroyed (or	959	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	960	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
917	a case where this is useful.	961	a case where this is useful.
918		962
919	Example: Create a watcher for the IO::AIO module and store it in	963	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.	964	C<$WATCHER>, but do so only do so after the event loop is initialised.
921		965
922	our WATCHER;	966	our WATCHER;
923		967
924	my $guard = AnyEvent::post_detect {	968	my $guard = AnyEvent::post_detect {
925	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	969	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
933	$WATCHER ||= $guard;	977	$WATCHER ||= $guard;
934		978
935	=item @AnyEvent::post_detect	979	=item @AnyEvent::post_detect
936		980
937	If there are any code references in this array (you can C<push> to it	981	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	982	before or after loading AnyEvent), then they will be called directly
939	the event loop has been chosen.	983	after the event loop has been chosen.
940		984
941	You should check C<$AnyEvent::MODEL> before adding to this array, though:	985	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	986	if it is defined then the event loop has already been detected, and the
943	array will be ignored.	987	array will be ignored.
944		988
945	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	989	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946	it,as it takes care of these details.	990	it, as it takes care of these details.
947		991
948	This variable is mainly useful for modules that can do something useful	992	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	993	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	994	not need to even load it by default. This array provides the means to hook
951	into AnyEvent passively, without loading it.	995	into AnyEvent passively, without loading it.
952		996
		997	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		998	together, you could put this into Coro (this is the actual code used by
		999	Coro to accomplish this):
		1000
		1001	if (defined $AnyEvent::MODEL) {
		1002	# AnyEvent already initialised, so load Coro::AnyEvent
		1003	require Coro::AnyEvent;
		1004	} else {
		1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1006	# as soon as it is
		1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1008	}
		1009
953	=back	1010	=back
954		1011
955	=head1 WHAT TO DO IN A MODULE	1012	=head1 WHAT TO DO IN A MODULE
956		1013
957	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1014	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	1024	because it will stall the whole program, and the whole point of using
968	events is to stay interactive.	1025	events is to stay interactive.
969		1026
970	It is fine, however, to call C<< ->recv >> when the user of your module	1027	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	1028	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 >>	1029	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).	1030	freely, as the user of your module knows what she is doing. Always).
974		1031
975	=head1 WHAT TO DO IN THE MAIN PROGRAM	1032	=head1 WHAT TO DO IN THE MAIN PROGRAM
976		1033
977	There will always be a single main program - the only place that should	1034	There will always be a single main program - the only place that should
978	dictate which event model to use.	1035	dictate which event model to use.
979		1036
980	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1037	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	1038	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.	1039	uses AnyEvent, but does not care which event loop is used, all it needs
		1040	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1041	available loop implementation.
983		1042
984	If the main program relies on a specific event model - for example, in	1043	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	1044	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	1045	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	1046	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	1047	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	1048	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.	1049	might choose the wrong one unless you load the correct one yourself.
991		1050
992	You can chose to use a pure-perl implementation by loading the	1051	You can chose to use a pure-perl implementation by loading the
993	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1052	C<AnyEvent::Loop> module, which gives you similar behaviour
994	everywhere, but letting AnyEvent chose the model is generally better.	1053	everywhere, but letting AnyEvent chose the model is generally better.
995		1054
996	=head2 MAINLOOP EMULATION	1055	=head2 MAINLOOP EMULATION
997		1056
998	Sometimes (often for short test scripts, or even standalone programs who	1057	Sometimes (often for short test scripts, or even standalone programs who
…		…
1013	=head1 OTHER MODULES	1072	=head1 OTHER MODULES
1014		1073
1015	The following is a non-exhaustive list of additional modules that use	1074	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	1075	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1017	modules and other event loops in the same program. Some of the modules	1076	modules and other event loops in the same program. Some of the modules
1018	come with AnyEvent, most are available via CPAN.	1077	come as part of AnyEvent, the others are available via CPAN.
1019		1078
1020	=over 4	1079	=over 4
1021		1080
1022	=item L<AnyEvent::Util>	1081	=item L<AnyEvent::Util>
1023		1082
1024	Contains various utility functions that replace often-used but blocking	1083	Contains various utility functions that replace often-used blocking
1025	functions such as C<inet_aton> by event-/callback-based versions.	1084	functions such as C<inet_aton> with event/callback-based versions.
1026		1085
1027	=item L<AnyEvent::Socket>	1086	=item L<AnyEvent::Socket>
1028		1087
1029	Provides various utility functions for (internet protocol) sockets,	1088	Provides various utility functions for (internet protocol) sockets,
1030	addresses and name resolution. Also functions to create non-blocking tcp	1089	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1032		1091
1033	=item L<AnyEvent::Handle>	1092	=item L<AnyEvent::Handle>
1034		1093
1035	Provide read and write buffers, manages watchers for reads and writes,	1094	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	1095	supports raw and formatted I/O, I/O queued and fully transparent and
1037	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1096	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1038		1097
1039	=item L<AnyEvent::DNS>	1098	=item L<AnyEvent::DNS>
1040		1099
1041	Provides rich asynchronous DNS resolver capabilities.	1100	Provides rich asynchronous DNS resolver capabilities.
1042		1101
		1102	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1103
		1104	Implement event-based interfaces to the protocols of the same name (for
		1105	the curious, IGS is the International Go Server and FCP is the Freenet
		1106	Client Protocol).
		1107
		1108	=item L<AnyEvent::Handle::UDP>
		1109
		1110	Here be danger!
		1111
		1112	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1113	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1114	its use of a stream-based API with a protocol that isn't streamable, that
		1115	the only way to improve it is to delete it.
		1116
		1117	It features data corruption (but typically only under load) and general
		1118	confusion. On top, the author is not only clueless about UDP but also
		1119	fact-resistant - some gems of his understanding: "connect doesn't work
		1120	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1121	packets", "I don't need to implement proper error checking as UDP doesn't
		1122	support error checking" and so on - he doesn't even understand what's
		1123	wrong with his module when it is explained to him.
		1124
1043	=item L<AnyEvent::HTTP>	1125	=item L<AnyEvent::DBI>
1044		1126
1045	A simple-to-use HTTP library that is capable of making a lot of concurrent	1127	Executes L<DBI> requests asynchronously in a proxy process for you,
1046	HTTP requests.	1128	notifying you in an event-based way when the operation is finished.
		1129
		1130	=item L<AnyEvent::AIO>
		1131
		1132	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1133	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1134	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1135	file I/O, and much more.
1047		1136
1048	=item L<AnyEvent::HTTPD>	1137	=item L<AnyEvent::HTTPD>
1049		1138
1050	Provides a simple web application server framework.	1139	A simple embedded webserver.
1051		1140
1052	=item L<AnyEvent::FastPing>	1141	=item L<AnyEvent::FastPing>
1053		1142
1054	The fastest ping in the west.	1143	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		1144
1098	=item L<Coro>	1145	=item L<Coro>
1099		1146
1100	Has special support for AnyEvent via L<Coro::AnyEvent>.	1147	Has special support for AnyEvent via L<Coro::AnyEvent>.
1101		1148
…		…
1105		1152
1106	package AnyEvent;	1153	package AnyEvent;
1107		1154
1108	# basically a tuned-down version of common::sense	1155	# basically a tuned-down version of common::sense
1109	sub common_sense {	1156	sub common_sense {
1110	# no warnings	1157	# from common:.sense 3.4
1111	${^WARNING_BITS} ^= ${^WARNING_BITS};	1158	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1112	# use strict vars subs	1159	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113	$^H |= 0x00000600;	1160	$^H |= 0x00000600;
1114	}	1161	}
1115		1162
1116	BEGIN { AnyEvent::common_sense }	1163	BEGIN { AnyEvent::common_sense }
1117		1164
1118	use Carp ();	1165	use Carp ();
1119		1166
1120	our $VERSION = 4.9;	1167	our $VERSION = '5.34';
1121	our $MODEL;	1168	our $MODEL;
1122		1169
1123	our $AUTOLOAD;	1170	our $AUTOLOAD;
1124	our @ISA;	1171	our @ISA;
1125		1172
1126	our @REGISTRY;	1173	our @REGISTRY;
1127		1174
1128	our $WIN32;
1129
1130	our $VERBOSE;	1175	our $VERBOSE;
1131		1176
1132	BEGIN {	1177	BEGIN {
1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1178	require "AnyEvent/constants.pl";
		1179
1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1180	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1135		1181
1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1182	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137	if ${^TAINT};	1183	if ${^TAINT};
1138		1184
1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1185	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1151	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1197	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1152	}	1198	}
1153		1199
1154	my @models = (	1200	my @models = (
1155	[EV:: => AnyEvent::Impl::EV:: , 1],	1201	[EV:: => AnyEvent::Impl::EV:: , 1],
		1202	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
		1203	# everything below here will not (normally) be autoprobed
		1204	# as the pure perl backend should work everywhere
		1205	# and is usually faster
1156	[Event:: => AnyEvent::Impl::Event::, 1],	1206	[Event:: => AnyEvent::Impl::Event::, 1],
1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158	# everything below here will not (normally) be autoprobed
1159	# as the pureperl backend should work everywhere
1160	# and is usually faster
1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1207	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1208	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1209	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1210	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1211	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1212	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1167	[Wx:: => AnyEvent::Impl::POE::],	1213	[Wx:: => AnyEvent::Impl::POE::],
1168	[Prima:: => AnyEvent::Impl::POE::],	1214	[Prima:: => AnyEvent::Impl::POE::],
1169	# IO::Async is just too broken - we would need workarounds for its
1170	# byzantine signal and broken child handling, among others.
1171	# IO::Async is rather hard to detect, as it doesn't have any
1172	# obvious default class.
1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1215	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],
1175	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1216	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1217	[FLTK:: => AnyEvent::Impl::FLTK::],
1176	);	1218	);
1177		1219
1178	our %method = map +($_ => 1),	1220	our %method = map +($_ => 1),
1179	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1221	qw(io timer time now now_update signal child idle condvar DESTROY);
1180		1222
1181	our @post_detect;	1223	our @post_detect;
1182		1224
1183	sub post_detect(&) {	1225	sub post_detect(&) {
1184	my ($cb) = @_;	1226	my ($cb) = @_;
1185		1227
1186	if ($MODEL) {
1187	$cb->();
1188
1189	undef
1190	} else {
1191	push @post_detect, $cb;	1228	push @post_detect, $cb;
1192		1229
1193	defined wantarray	1230	defined wantarray
1194	? bless \$cb, "AnyEvent::Util::postdetect"	1231	? bless \$cb, "AnyEvent::Util::postdetect"
1195	: ()	1232	: ()
1196	}
1197	}	1233	}
1198		1234
1199	sub AnyEvent::Util::postdetect::DESTROY {	1235	sub AnyEvent::Util::postdetect::DESTROY {
1200	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1236	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1201	}	1237	}
1202		1238
1203	sub detect() {	1239	sub detect() {
		1240	# free some memory
		1241	*detect = sub () { $MODEL };
		1242
		1243	local $!; # for good measure
		1244	local $SIG{__DIE__};
		1245
		1246	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1247	my $model = "AnyEvent::Impl::$1";
		1248	if (eval "require $model") {
		1249	$MODEL = $model;
		1250	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1251	} else {
		1252	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1253	}
		1254	}
		1255
		1256	# check for already loaded models
1204	unless ($MODEL) {	1257	unless ($MODEL) {
1205	local $SIG{__DIE__};	1258	for (@REGISTRY, @models) {
1206		1259	my ($package, $model) = @$_;
1207	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1260	if (${"$package\::VERSION"} > 0) {
1208	my $model = "AnyEvent::Impl::$1";
1209	if (eval "require $model") {	1261	if (eval "require $model") {
1210	$MODEL = $model;	1262	$MODEL = $model;
1211	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1263	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1212	} else {	1264	last;
1213	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1265	}
1214	}	1266	}
1215	}	1267	}
1216		1268
1217	# check for already loaded models
1218	unless ($MODEL) {	1269	unless ($MODEL) {
		1270	# try to autoload a model
1219	for (@REGISTRY, @models) {	1271	for (@REGISTRY, @models) {
1220	my ($package, $model) = @$_;	1272	my ($package, $model, $autoload) = @$_;
		1273	if (
		1274	$autoload
		1275	and eval "require $package"
1221	if (${"$package\::VERSION"} > 0) {	1276	and ${"$package\::VERSION"} > 0
1222	if (eval "require $model") {	1277	and eval "require $model"
		1278	) {
1223	$MODEL = $model;	1279	$MODEL = $model;
1224	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1280	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1225	last;	1281	last;
1226	}
1227	}	1282	}
1228	}	1283	}
1229		1284
1230	unless ($MODEL) {
1231	# try to autoload a model
1232	for (@REGISTRY, @models) {
1233	my ($package, $model, $autoload) = @$_;
1234	if (
1235	$autoload
1236	and eval "require $package"
1237	and ${"$package\::VERSION"} > 0
1238	and eval "require $model"
1239	) {
1240	$MODEL = $model;
1241	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1242	last;
1243	}
1244	}
1245
1246	$MODEL	1285	$MODEL
1247	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1286	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1248	}
1249	}	1287	}
1250
1251	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1252
1253	unshift @ISA, $MODEL;
1254
1255	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1256
1257	(shift @post_detect)->() while @post_detect;
1258	}	1288	}
		1289
		1290	@models = (); # free probe data
		1291
		1292	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1293	unshift @ISA, $MODEL;
		1294
		1295	# now nuke some methods that are overridden by the backend.
		1296	# SUPER is not allowed.
		1297	for (qw(time signal child idle)) {
		1298	undef &{"AnyEvent::Base::$_"}
		1299	if defined &{"$MODEL\::$_"};
		1300	}
		1301
		1302	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1303	eval { require AnyEvent::Strict };
		1304	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
		1305	if $@ && $VERBOSE;
		1306	}
		1307
		1308	(shift @post_detect)->() while @post_detect;
		1309
		1310	*post_detect = sub(&) {
		1311	shift->();
		1312
		1313	undef
		1314	};
1259		1315
1260	$MODEL	1316	$MODEL
1261	}	1317	}
1262		1318
1263	sub AUTOLOAD {	1319	sub AUTOLOAD {
1264	(my $func = $AUTOLOAD) =~ s/.*://;	1320	(my $func = $AUTOLOAD) =~ s/.*://;
1265		1321
1266	$method{$func}	1322	$method{$func}
1267	or Carp::croak "$func: not a valid method for AnyEvent objects";	1323	or Carp::croak "$func: not a valid AnyEvent class method";
1268		1324
1269	detect unless $MODEL;	1325	detect;
1270		1326
1271	my $class = shift;	1327	my $class = shift;
1272	$class->$func (@_);	1328	$class->$func (@_);
1273	}	1329	}
1274		1330
…		…
1287	# we assume CLOEXEC is already set by perl in all important cases	1343	# we assume CLOEXEC is already set by perl in all important cases
1288		1344
1289	($fh2, $rw)	1345	($fh2, $rw)
1290	}	1346	}
1291		1347
		1348	=head1 SIMPLIFIED AE API
		1349
		1350	Starting with version 5.0, AnyEvent officially supports a second, much
		1351	simpler, API that is designed to reduce the calling, typing and memory
		1352	overhead by using function call syntax and a fixed number of parameters.
		1353
		1354	See the L<AE> manpage for details.
		1355
		1356	=cut
		1357
		1358	package AE;
		1359
		1360	our $VERSION = $AnyEvent::VERSION;
		1361
		1362	# fall back to the main API by default - backends and AnyEvent::Base
		1363	# implementations can overwrite these.
		1364
		1365	sub io($$$) {
		1366	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1367	}
		1368
		1369	sub timer($$$) {
		1370	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1371	}
		1372
		1373	sub signal($$) {
		1374	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1375	}
		1376
		1377	sub child($$) {
		1378	AnyEvent->child (pid => $_[0], cb => $_[1])
		1379	}
		1380
		1381	sub idle($) {
		1382	AnyEvent->idle (cb => $_[0])
		1383	}
		1384
		1385	sub cv(;&) {
		1386	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1387	}
		1388
		1389	sub now() {
		1390	AnyEvent->now
		1391	}
		1392
		1393	sub now_update() {
		1394	AnyEvent->now_update
		1395	}
		1396
		1397	sub time() {
		1398	AnyEvent->time
		1399	}
		1400
1292	package AnyEvent::Base;	1401	package AnyEvent::Base;
1293		1402
1294	# default implementations for many methods	1403	# default implementations for many methods
1295		1404
1296	sub _time {	1405	sub time {
		1406	eval q{ # poor man's autoloading {}
1297	# probe for availability of Time::HiRes	1407	# probe for availability of Time::HiRes
1298	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1408	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1299	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1409	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1300	*_time = \&Time::HiRes::time;	1410	*AE::time = \&Time::HiRes::time;
1301	# if (eval "use POSIX (); (POSIX::times())...	1411	# if (eval "use POSIX (); (POSIX::times())...
1302	} else {	1412	} else {
1303	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1413	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1304	*_time = sub { time }; # epic fail	1414	*AE::time = sub (){ time }; # epic fail
		1415	}
		1416
		1417	*time = sub { AE::time }; # different prototypes
1305	}	1418	};
		1419	die if $@;
1306		1420
1307	&_time	1421	&time
1308	}	1422	}
1309		1423
1310	sub time { _time }	1424	*now = \&time;
1311	sub now { _time }	1425
1312	sub now_update { }	1426	sub now_update { }
1313		1427
		1428	sub _poll {
		1429	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1430	}
		1431
1314	# default implementation for ->condvar	1432	# default implementation for ->condvar
		1433	# in fact,t he default should not be overwritten
1315		1434
1316	sub condvar {	1435	sub condvar {
		1436	eval q{ # poor man's autoloading {}
		1437	*condvar = sub {
1317	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1438	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1439	};
		1440
		1441	*AE::cv = sub (;&) {
		1442	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1443	};
		1444	};
		1445	die if $@;
		1446
		1447	&condvar
1318	}	1448	}
1319		1449
1320	# default implementation for ->signal	1450	# default implementation for ->signal
1321		1451
1322	our $HAVE_ASYNC_INTERRUPT;	1452	our $HAVE_ASYNC_INTERRUPT;
1323		1453
1324	sub _have_async_interrupt() {	1454	sub _have_async_interrupt() {
1325	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1455	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1326	&& eval "use Async::Interrupt 1.0 (); 1")	1456	&& eval "use Async::Interrupt 1.02 (); 1")
1327	unless defined $HAVE_ASYNC_INTERRUPT;	1457	unless defined $HAVE_ASYNC_INTERRUPT;
1328		1458
1329	$HAVE_ASYNC_INTERRUPT	1459	$HAVE_ASYNC_INTERRUPT
1330	}	1460	}
1331		1461
1332	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1462	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1333	our (%SIG_ASY, %SIG_ASY_W);	1463	our (%SIG_ASY, %SIG_ASY_W);
1334	our ($SIG_COUNT, $SIG_TW);	1464	our ($SIG_COUNT, $SIG_TW);
1335		1465
1336	sub _signal_exec {
1337	$HAVE_ASYNC_INTERRUPT
1338	? $SIGPIPE_R->drain
1339	: sysread $SIGPIPE_R, my $dummy, 9;
1340
1341	while (%SIG_EV) {
1342	for (keys %SIG_EV) {
1343	delete $SIG_EV{$_};
1344	$_->() for values %{ $SIG_CB{$_} || {} };
1345	}
1346	}
1347	}
1348
1349	# install a dummy wakeup watcher to reduce signal catching latency	1466	# install a dummy wakeup watcher to reduce signal catching latency
		1467	# used by Impls
1350	sub _sig_add() {	1468	sub _sig_add() {
1351	unless ($SIG_COUNT++) {	1469	unless ($SIG_COUNT++) {
1352	# try to align timer on a full-second boundary, if possible	1470	# try to align timer on a full-second boundary, if possible
1353	my $NOW = AnyEvent->now;	1471	my $NOW = AE::now;
1354		1472
1355	$SIG_TW = AnyEvent->timer (	1473	$SIG_TW = AE::timer
1356	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1474	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1357	interval => $MAX_SIGNAL_LATENCY,	1475	$MAX_SIGNAL_LATENCY,
1358	cb => sub { }, # just for the PERL_ASYNC_CHECK	1476	sub { } # just for the PERL_ASYNC_CHECK
1359	);	1477	;
1360	}	1478	}
1361	}	1479	}
1362		1480
1363	sub _sig_del {	1481	sub _sig_del {
1364	undef $SIG_TW	1482	undef $SIG_TW
1365	unless --$SIG_COUNT;	1483	unless --$SIG_COUNT;
1366	}	1484	}
1367		1485
1368	our $_sig_name_init; $_sig_name_init = sub {	1486	our $_sig_name_init; $_sig_name_init = sub {
1369	eval q{ # poor man's autoloading	1487	eval q{ # poor man's autoloading {}
1370	undef $_sig_name_init;	1488	undef $_sig_name_init;
1371		1489
1372	if (_have_async_interrupt) {	1490	if (_have_async_interrupt) {
1373	*sig2num = \&Async::Interrupt::sig2num;	1491	*sig2num = \&Async::Interrupt::sig2num;
1374	*sig2name = \&Async::Interrupt::sig2name;	1492	*sig2name = \&Async::Interrupt::sig2name;
…		…
1401	# probe for availability of Async::Interrupt	1519	# probe for availability of Async::Interrupt
1402	if (_have_async_interrupt) {	1520	if (_have_async_interrupt) {
1403	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1521	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1404		1522
1405	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1523	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1406	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1524	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1407		1525
1408	} else {	1526	} else {
1409	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1527	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410
1411	require Fcntl;
1412		1528
1413	if (AnyEvent::WIN32) {	1529	if (AnyEvent::WIN32) {
1414	require AnyEvent::Util;	1530	require AnyEvent::Util;
1415		1531
1416	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1532	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1417	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1533	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1418	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1534	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1419	} else {	1535	} else {
1420	pipe $SIGPIPE_R, $SIGPIPE_W;	1536	pipe $SIGPIPE_R, $SIGPIPE_W;
1421	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1537	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1422	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1538	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1423		1539
1424	# not strictly required, as $^F is normally 2, but let's make sure...	1540	# not strictly required, as $^F is normally 2, but let's make sure...
1425	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1541	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1426	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1542	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1427	}	1543	}
1428		1544
1429	$SIGPIPE_R	1545	$SIGPIPE_R
1430	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1546	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431		1547
1432	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1548	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1433	}	1549	}
1434		1550
1435	*signal = sub {	1551	*signal = $HAVE_ASYNC_INTERRUPT
		1552	? sub {
1436	my (undef, %arg) = @_;	1553	my (undef, %arg) = @_;
1437		1554
1438	my $signal = uc $arg{signal}
1439	or Carp::croak "required option 'signal' is missing";
1440
1441	if ($HAVE_ASYNC_INTERRUPT) {
1442	# async::interrupt	1555	# async::interrupt
1443
1444	$signal = sig2num $signal;	1556	my $signal = sig2num $arg{signal};
1445	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1557	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1446		1558
1447	$SIG_ASY{$signal} ||= new Async::Interrupt	1559	$SIG_ASY{$signal} ||= new Async::Interrupt
1448	cb => sub { undef $SIG_EV{$signal} },	1560	cb => sub { undef $SIG_EV{$signal} },
1449	signal => $signal,	1561	signal => $signal,
1450	pipe => [$SIGPIPE_R->filenos],	1562	pipe => [$SIGPIPE_R->filenos],
1451	pipe_autodrain => 0,	1563	pipe_autodrain => 0,
1452	;	1564	;
1453		1565
1454	} else {	1566	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1567	}
		1568	: sub {
		1569	my (undef, %arg) = @_;
		1570
1455	# pure perl	1571	# pure perl
1456
1457	# AE::Util has been loaded in signal
1458	$signal = sig2name $signal;	1572	my $signal = sig2name $arg{signal};
1459	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1573	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1460		1574
1461	$SIG{$signal} ||= sub {	1575	$SIG{$signal} ||= sub {
1462	local $!;	1576	local $!;
1463	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1577	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1464	undef $SIG_EV{$signal};	1578	undef $SIG_EV{$signal};
1465	};	1579	};
1466		1580
1467	# can't do signal processing without introducing races in pure perl,	1581	# can't do signal processing without introducing races in pure perl,
1468	# so limit the signal latency.	1582	# so limit the signal latency.
1469	_sig_add;	1583	_sig_add;
1470	}
1471		1584
1472	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1585	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1586	}
1473	};	1587	;
1474		1588
1475	*AnyEvent::Base::signal::DESTROY = sub {	1589	*AnyEvent::Base::signal::DESTROY = sub {
1476	my ($signal, $cb) = @{$_[0]};	1590	my ($signal, $cb) = @{$_[0]};
1477		1591
1478	_sig_del;	1592	_sig_del;
…		…
1485	# print weird messages, or just unconditionally exit	1599	# print weird messages, or just unconditionally exit
1486	# instead of getting the default action.	1600	# instead of getting the default action.
1487	undef $SIG{$signal}	1601	undef $SIG{$signal}
1488	unless keys %{ $SIG_CB{$signal} };	1602	unless keys %{ $SIG_CB{$signal} };
1489	};	1603	};
		1604
		1605	*_signal_exec = sub {
		1606	$HAVE_ASYNC_INTERRUPT
		1607	? $SIGPIPE_R->drain
		1608	: sysread $SIGPIPE_R, (my $dummy), 9;
		1609
		1610	while (%SIG_EV) {
		1611	for (keys %SIG_EV) {
		1612	delete $SIG_EV{$_};
		1613	$_->() for values %{ $SIG_CB{$_} || {} };
		1614	}
		1615	}
		1616	};
1490	};	1617	};
1491	die if $@;	1618	die if $@;
		1619
1492	&signal	1620	&signal
1493	}	1621	}
1494		1622
1495	# default implementation for ->child	1623	# default implementation for ->child
1496		1624
1497	our %PID_CB;	1625	our %PID_CB;
1498	our $CHLD_W;	1626	our $CHLD_W;
1499	our $CHLD_DELAY_W;	1627	our $CHLD_DELAY_W;
1500	our $WNOHANG;
1501		1628
		1629	# used by many Impl's
1502	sub _emit_childstatus($$) {	1630	sub _emit_childstatus($$) {
1503	my (undef, $rpid, $rstatus) = @_;	1631	my (undef, $rpid, $rstatus) = @_;
1504		1632
1505	$_->($rpid, $rstatus)	1633	$_->($rpid, $rstatus)
1506	for values %{ $PID_CB{$rpid} || {} },	1634	for values %{ $PID_CB{$rpid} || {} },
1507	values %{ $PID_CB{0} || {} };	1635	values %{ $PID_CB{0} || {} };
1508	}	1636	}
1509		1637
1510	sub _sigchld {
1511	my $pid;
1512
1513	AnyEvent->_emit_childstatus ($pid, $?)
1514	while ($pid = waitpid -1, $WNOHANG) > 0;
1515	}
1516
1517	sub child {	1638	sub child {
		1639	eval q{ # poor man's autoloading {}
		1640	*_sigchld = sub {
		1641	my $pid;
		1642
		1643	AnyEvent->_emit_childstatus ($pid, $?)
		1644	while ($pid = waitpid -1, WNOHANG) > 0;
		1645	};
		1646
		1647	*child = sub {
1518	my (undef, %arg) = @_;	1648	my (undef, %arg) = @_;
1519		1649
1520	defined (my $pid = $arg{pid} + 0)	1650	my $pid = $arg{pid};
1521	or Carp::croak "required option 'pid' is missing";	1651	my $cb = $arg{cb};
1522		1652
1523	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1653	$PID_CB{$pid}{$cb+0} = $cb;
1524		1654
1525	# WNOHANG is almost cetrainly 1 everywhere
1526	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1527	? 1
1528	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1529
1530	unless ($CHLD_W) {	1655	unless ($CHLD_W) {
1531	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1656	$CHLD_W = AE::signal CHLD => \&_sigchld;
1532	# child could be a zombie already, so make at least one round	1657	# child could be a zombie already, so make at least one round
1533	&_sigchld;	1658	&_sigchld;
1534	}	1659	}
1535		1660
1536	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1661	bless [$pid, $cb+0], "AnyEvent::Base::child"
1537	}	1662	};
1538		1663
1539	sub AnyEvent::Base::child::DESTROY {	1664	*AnyEvent::Base::child::DESTROY = sub {
1540	my ($pid, $cb) = @{$_[0]};	1665	my ($pid, $icb) = @{$_[0]};
1541		1666
1542	delete $PID_CB{$pid}{$cb};	1667	delete $PID_CB{$pid}{$icb};
1543	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1668	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1544		1669
1545	undef $CHLD_W unless keys %PID_CB;	1670	undef $CHLD_W unless keys %PID_CB;
		1671	};
		1672	};
		1673	die if $@;
		1674
		1675	&child
1546	}	1676	}
1547		1677
1548	# idle emulation is done by simply using a timer, regardless	1678	# idle emulation is done by simply using a timer, regardless
1549	# of whether the process is idle or not, and not letting	1679	# of whether the process is idle or not, and not letting
1550	# the callback use more than 50% of the time.	1680	# the callback use more than 50% of the time.
1551	sub idle {	1681	sub idle {
		1682	eval q{ # poor man's autoloading {}
		1683	*idle = sub {
1552	my (undef, %arg) = @_;	1684	my (undef, %arg) = @_;
1553		1685
1554	my ($cb, $w, $rcb) = $arg{cb};	1686	my ($cb, $w, $rcb) = $arg{cb};
1555		1687
1556	$rcb = sub {	1688	$rcb = sub {
1557	if ($cb) {	1689	if ($cb) {
1558	$w = _time;	1690	$w = _time;
1559	&$cb;	1691	&$cb;
1560	$w = _time - $w;	1692	$w = _time - $w;
1561		1693
1562	# never use more then 50% of the time for the idle watcher,	1694	# never use more then 50% of the time for the idle watcher,
1563	# within some limits	1695	# within some limits
1564	$w = 0.0001 if $w < 0.0001;	1696	$w = 0.0001 if $w < 0.0001;
1565	$w = 5 if $w > 5;	1697	$w = 5 if $w > 5;
1566		1698
1567	$w = AnyEvent->timer (after => $w, cb => $rcb);	1699	$w = AE::timer $w, 0, $rcb;
1568	} else {	1700	} else {
1569	# clean up...	1701	# clean up...
1570	undef $w;	1702	undef $w;
1571	undef $rcb;	1703	undef $rcb;
		1704	}
		1705	};
		1706
		1707	$w = AE::timer 0.05, 0, $rcb;
		1708
		1709	bless \\$cb, "AnyEvent::Base::idle"
1572	}	1710	};
		1711
		1712	*AnyEvent::Base::idle::DESTROY = sub {
		1713	undef $${$_[0]};
		1714	};
1573	};	1715	};
		1716	die if $@;
1574		1717
1575	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1718	&idle
1576
1577	bless \\$cb, "AnyEvent::Base::idle"
1578	}
1579
1580	sub AnyEvent::Base::idle::DESTROY {
1581	undef $${$_[0]};
1582	}	1719	}
1583		1720
1584	package AnyEvent::CondVar;	1721	package AnyEvent::CondVar;
1585		1722
1586	our @ISA = AnyEvent::CondVar::Base::;	1723	our @ISA = AnyEvent::CondVar::Base::;
		1724
		1725	# only to be used for subclassing
		1726	sub new {
		1727	my $class = shift;
		1728	bless AnyEvent->condvar (@_), $class
		1729	}
1587		1730
1588	package AnyEvent::CondVar::Base;	1731	package AnyEvent::CondVar::Base;
1589		1732
1590	#use overload	1733	#use overload
1591	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1734	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
…		…
1601		1744
1602	sub _send {	1745	sub _send {
1603	# nop	1746	# nop
1604	}	1747	}
1605		1748
		1749	sub _wait {
		1750	AnyEvent->_poll until $_[0]{_ae_sent};
		1751	}
		1752
1606	sub send {	1753	sub send {
1607	my $cv = shift;	1754	my $cv = shift;
1608	$cv->{_ae_sent} = [@_];	1755	$cv->{_ae_sent} = [@_];
1609	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1756	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1610	$cv->_send;	1757	$cv->_send;
…		…
1617		1764
1618	sub ready {	1765	sub ready {
1619	$_[0]{_ae_sent}	1766	$_[0]{_ae_sent}
1620	}	1767	}
1621		1768
1622	sub _wait {
1623	$WAITING
1624	and !$_[0]{_ae_sent}
1625	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1626
1627	local $WAITING = 1;
1628	AnyEvent->one_event while !$_[0]{_ae_sent};
1629	}
1630
1631	sub recv {	1769	sub recv {
		1770	unless ($_[0]{_ae_sent}) {
		1771	$WAITING
		1772	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1773
		1774	local $WAITING = 1;
1632	$_[0]->_wait;	1775	$_[0]->_wait;
		1776	}
1633		1777
1634	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1778	$_[0]{_ae_croak}
1635	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1779	and Carp::croak $_[0]{_ae_croak};
		1780
		1781	wantarray
		1782	? @{ $_[0]{_ae_sent} }
		1783	: $_[0]{_ae_sent}[0]
1636	}	1784	}
1637		1785
1638	sub cb {	1786	sub cb {
1639	my $cv = shift;	1787	my $cv = shift;
1640		1788
1641	@_	1789	@_
1642	and $cv->{_ae_cb} = shift	1790	and $cv->{_ae_cb} = shift
1643	and $cv->{_ae_sent}	1791	and $cv->{_ae_sent}
1644	and (delete $cv->{_ae_cb})->($cv);	1792	and (delete $cv->{_ae_cb})->($cv);
		1793
1645	$cv->{_ae_cb}	1794	$cv->{_ae_cb}
1646	}	1795	}
1647		1796
1648	sub begin {	1797	sub begin {
1649	++$_[0]{_ae_counter};	1798	++$_[0]{_ae_counter};
…		…
1655	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1804	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1656	}	1805	}
1657		1806
1658	# undocumented/compatibility with pre-3.4	1807	# undocumented/compatibility with pre-3.4
1659	*broadcast = \&send;	1808	*broadcast = \&send;
1660	*wait = \&_wait;	1809	*wait = \&recv;
1661
1662	#############################################################################
1663	# "new" API, currently only emulation of it
1664	#############################################################################
1665
1666	package AE;
1667
1668	sub io($$$) {
1669	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1670	}
1671
1672	sub timer($$$) {
1673	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1674	}
1675
1676	sub signal($$) {
1677	AnyEvent->signal (signal => $_[0], cb => $_[1]);
1678	}
1679
1680	sub child($$) {
1681	AnyEvent->child (pid => $_[0], cb => $_[1]);
1682	}
1683
1684	sub idle($) {
1685	AnyEvent->idle (cb => $_[0]);
1686	}
1687
1688	sub cv() {
1689	AnyEvent->condvar
1690	}
1691
1692	sub now() {
1693	AnyEvent->now
1694	}
1695
1696	sub now_update() {
1697	AnyEvent->now_update
1698	}
1699
1700	sub time() {
1701	AnyEvent->time
1702	}
1703		1810
1704	=head1 ERROR AND EXCEPTION HANDLING	1811	=head1 ERROR AND EXCEPTION HANDLING
1705		1812
1706	In general, AnyEvent does not do any error handling - it relies on the	1813	In general, AnyEvent does not do any error handling - it relies on the
1707	caller to do that if required. The L<AnyEvent::Strict> module (see also	1814	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1754	check the arguments passed to most method calls. If it finds any problems,	1861	check the arguments passed to most method calls. If it finds any problems,
1755	it will croak.	1862	it will croak.
1756		1863
1757	In other words, enables "strict" mode.	1864	In other words, enables "strict" mode.
1758		1865
1759	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	1866	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1760	>>, it is definitely recommended to keep it off in production. Keeping	1867	>>, it is definitely recommended to keep it off in production. Keeping
1761	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1868	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1762	can be very useful, however.	1869	can be very useful, however.
1763		1870
1764	=item C<PERL_ANYEVENT_MODEL>	1871	=item C<PERL_ANYEVENT_MODEL>
…		…
1770	used as event model. If it fails to load AnyEvent will proceed with	1877	used as event model. If it fails to load AnyEvent will proceed with
1771	auto detection and -probing.	1878	auto detection and -probing.
1772		1879
1773	This functionality might change in future versions.	1880	This functionality might change in future versions.
1774		1881
1775	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1882	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1776	could start your program like this:	1883	could start your program like this:
1777		1884
1778	PERL_ANYEVENT_MODEL=Perl perl ...	1885	PERL_ANYEVENT_MODEL=Perl perl ...
1779		1886
1780	=item C<PERL_ANYEVENT_PROTOCOLS>	1887	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1901	warn "read: $input\n"; # output what has been read	2008	warn "read: $input\n"; # output what has been read
1902	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2009	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1903	},	2010	},
1904	);	2011	);
1905		2012
1906	my $time_watcher; # can only be used once
1907
1908	sub new_timer {
1909	$timer = AnyEvent->timer (after => 1, cb => sub {	2013	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1910	warn "timeout\n"; # print 'timeout' about every second	2014	warn "timeout\n"; # print 'timeout' at most every second
1911	&new_timer; # and restart the time
1912	});	2015	});
1913	}
1914
1915	new_timer; # create first timer
1916		2016
1917	$cv->recv; # wait until user enters /^q/i	2017	$cv->recv; # wait until user enters /^q/i
1918		2018
1919	=head1 REAL-WORLD EXAMPLE	2019	=head1 REAL-WORLD EXAMPLE
1920		2020
…		…
1993		2093
1994	The actual code goes further and collects all errors (C<die>s, exceptions)	2094	The actual code goes further and collects all errors (C<die>s, exceptions)
1995	that occurred during request processing. The C<result> method detects	2095	that occurred during request processing. The C<result> method detects
1996	whether an exception as thrown (it is stored inside the $txn object)	2096	whether an exception as thrown (it is stored inside the $txn object)
1997	and just throws the exception, which means connection errors and other	2097	and just throws the exception, which means connection errors and other
1998	problems get reported tot he code that tries to use the result, not in a	2098	problems get reported to the code that tries to use the result, not in a
1999	random callback.	2099	random callback.
2000		2100
2001	All of this enables the following usage styles:	2101	All of this enables the following usage styles:
2002		2102
2003	1. Blocking:	2103	1. Blocking:
…		…
2051	through AnyEvent. The benchmark creates a lot of timers (with a zero	2151	through AnyEvent. The benchmark creates a lot of timers (with a zero
2052	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2152	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2053	which it is), lets them fire exactly once and destroys them again.	2153	which it is), lets them fire exactly once and destroys them again.
2054		2154
2055	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2155	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2056	distribution.	2156	distribution. It uses the L<AE> interface, which makes a real difference
		2157	for the EV and Perl backends only.
2057		2158
2058	=head3 Explanation of the columns	2159	=head3 Explanation of the columns
2059		2160
2060	I<watcher> is the number of event watchers created/destroyed. Since	2161	I<watcher> is the number of event watchers created/destroyed. Since
2061	different event models feature vastly different performances, each event	2162	different event models feature vastly different performances, each event
…		…
2082	watcher.	2183	watcher.
2083		2184
2084	=head3 Results	2185	=head3 Results
2085		2186
2086	name watchers bytes create invoke destroy comment	2187	name watchers bytes create invoke destroy comment
2087	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2188	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2088	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2189	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2089	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2190	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2090	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2191	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2091	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2192	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2092	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2193	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2093	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2194	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2094	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2195	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2095	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2196	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2096	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2197	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2097	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2198	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2098	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2199	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2099		2200
2100	=head3 Discussion	2201	=head3 Discussion
2101		2202
2102	The benchmark does I<not> measure scalability of the event loop very	2203	The benchmark does I<not> measure scalability of the event loop very
2103	well. For example, a select-based event loop (such as the pure perl one)	2204	well. For example, a select-based event loop (such as the pure perl one)
…		…
2115	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2216	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2116	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2217	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2117	cycles with POE.	2218	cycles with POE.
2118		2219
2119	C<EV> is the sole leader regarding speed and memory use, which are both	2220	C<EV> is the sole leader regarding speed and memory use, which are both
2120	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2221	maximal/minimal, respectively. When using the L<AE> API there is zero
		2222	overhead (when going through the AnyEvent API create is about 5-6 times
		2223	slower, with other times being equal, so still uses far less memory than
2121	far less memory than any other event loop and is still faster than Event	2224	any other event loop and is still faster than Event natively).
2122	natively.
2123		2225
2124	The pure perl implementation is hit in a few sweet spots (both the	2226	The pure perl implementation is hit in a few sweet spots (both the
2125	constant timeout and the use of a single fd hit optimisations in the perl	2227	constant timeout and the use of a single fd hit optimisations in the perl
2126	interpreter and the backend itself). Nevertheless this shows that it	2228	interpreter and the backend itself). Nevertheless this shows that it
2127	adds very little overhead in itself. Like any select-based backend its	2229	adds very little overhead in itself. Like any select-based backend its
…		…
2201	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2303	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2202	(1%) are active. This mirrors the activity of large servers with many	2304	(1%) are active. This mirrors the activity of large servers with many
2203	connections, most of which are idle at any one point in time.	2305	connections, most of which are idle at any one point in time.
2204		2306
2205	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2307	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2206	distribution.	2308	distribution. It uses the L<AE> interface, which makes a real difference
		2309	for the EV and Perl backends only.
2207		2310
2208	=head3 Explanation of the columns	2311	=head3 Explanation of the columns
2209		2312
2210	I<sockets> is the number of sockets, and twice the number of "servers" (as	2313	I<sockets> is the number of sockets, and twice the number of "servers" (as
2211	each server has a read and write socket end).	2314	each server has a read and write socket end).
…		…
2219	a new one that moves the timeout into the future.	2322	a new one that moves the timeout into the future.
2220		2323
2221	=head3 Results	2324	=head3 Results
2222		2325
2223	name sockets create request	2326	name sockets create request
2224	EV 20000 69.01 11.16	2327	EV 20000 62.66 7.99
2225	Perl 20000 73.32 35.87	2328	Perl 20000 68.32 32.64
2226	IOAsync 20000 157.00 98.14 epoll	2329	IOAsync 20000 174.06 101.15 epoll
2227	IOAsync 20000 159.31 616.06 poll	2330	IOAsync 20000 174.67 610.84 poll
2228	Event 20000 212.62 257.32	2331	Event 20000 202.69 242.91
2229	Glib 20000 651.16 1896.30	2332	Glib 20000 557.01 1689.52
2230	POE 20000 349.67 12317.24 uses POE::Loop::Event	2333	POE 20000 341.54 12086.32 uses POE::Loop::Event
2231		2334
2232	=head3 Discussion	2335	=head3 Discussion
2233		2336
2234	This benchmark I<does> measure scalability and overall performance of the	2337	This benchmark I<does> measure scalability and overall performance of the
2235	particular event loop.	2338	particular event loop.
…		…
2361	As you can see, the AnyEvent + EV combination even beats the	2464	As you can see, the AnyEvent + EV combination even beats the
2362	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2465	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2363	backend easily beats IO::Lambda and POE.	2466	backend easily beats IO::Lambda and POE.
2364		2467
2365	And even the 100% non-blocking version written using the high-level (and	2468	And even the 100% non-blocking version written using the high-level (and
2366	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2469	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2367	large margin, even though it does all of DNS, tcp-connect and socket I/O	2470	higher level ("unoptimised") abstractions by a large margin, even though
2368	in a non-blocking way.	2471	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2369		2472
2370	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2473	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2371	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2474	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2372	part of the IO::lambda distribution and were used without any changes.	2475	part of the IO::Lambda distribution and were used without any changes.
2373		2476
2374		2477
2375	=head1 SIGNALS	2478	=head1 SIGNALS
2376		2479
2377	AnyEvent currently installs handlers for these signals:	2480	AnyEvent currently installs handlers for these signals:
…		…
2414	unless defined $SIG{PIPE};	2517	unless defined $SIG{PIPE};
2415		2518
2416	=head1 RECOMMENDED/OPTIONAL MODULES	2519	=head1 RECOMMENDED/OPTIONAL MODULES
2417		2520
2418	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2521	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2419	it's built-in modules) are required to use it.	2522	its built-in modules) are required to use it.
2420		2523
2421	That does not mean that AnyEvent won't take advantage of some additional	2524	That does not mean that AnyEvent won't take advantage of some additional
2422	modules if they are installed.	2525	modules if they are installed.
2423		2526
2424	This section epxlains which additional modules will be used, and how they	2527	This section explains which additional modules will be used, and how they
2425	affect AnyEvent's operetion.	2528	affect AnyEvent's operation.
2426		2529
2427	=over 4	2530	=over 4
2428		2531
2429	=item L<Async::Interrupt>	2532	=item L<Async::Interrupt>
2430		2533
…		…
2435	catch the signals) with some delay (default is 10 seconds, look for	2538	catch the signals) with some delay (default is 10 seconds, look for
2436	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2539	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2437		2540
2438	If this module is available, then it will be used to implement signal	2541	If this module is available, then it will be used to implement signal
2439	catching, which means that signals will not be delayed, and the event loop	2542	catching, which means that signals will not be delayed, and the event loop
2440	will not be interrupted regularly, which is more efficient (And good for	2543	will not be interrupted regularly, which is more efficient (and good for
2441	battery life on laptops).	2544	battery life on laptops).
2442		2545
2443	This affects not just the pure-perl event loop, but also other event loops	2546	This affects not just the pure-perl event loop, but also other event loops
2444	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2547	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2445		2548
…		…
2457	automatic timer adjustments even when no monotonic clock is available,	2560	automatic timer adjustments even when no monotonic clock is available,
2458	can take avdantage of advanced kernel interfaces such as C<epoll> and	2561	can take avdantage of advanced kernel interfaces such as C<epoll> and
2459	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2562	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2460	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2563	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2461		2564
		2565	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2566	then this module will do nothing for you.
		2567
2462	=item L<Guard>	2568	=item L<Guard>
2463		2569
2464	The guard module, when used, will be used to implement	2570	The guard module, when used, will be used to implement
2465	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2571	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2466	lot less memory), but otherwise doesn't affect guard operation much. It is	2572	lot less memory), but otherwise doesn't affect guard operation much. It is
2467	purely used for performance.	2573	purely used for performance.
2468		2574
2469	=item L<JSON> and L<JSON::XS>	2575	=item L<JSON> and L<JSON::XS>
2470		2576
2471	This module is required when you want to read or write JSON data via	2577	One of these modules is required when you want to read or write JSON data
2472	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2578	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2473	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2579	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2474
2475	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2476	installed.
2477		2580
2478	=item L<Net::SSLeay>	2581	=item L<Net::SSLeay>
2479		2582
2480	Implementing TLS/SSL in Perl is certainly interesting, but not very	2583	Implementing TLS/SSL in Perl is certainly interesting, but not very
2481	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2584	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2482	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2585	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2483		2586
2484	=item L<Time::HiRes>	2587	=item L<Time::HiRes>
2485		2588
2486	This module is part of perl since release 5.008. It will be used when the	2589	This module is part of perl since release 5.008. It will be used when the
2487	chosen event library does not come with a timing source on it's own. The	2590	chosen event library does not come with a timing source of its own. The
2488	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2591	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2489	try to use a monotonic clock for timing stability.	2592	try to use a monotonic clock for timing stability.
2490		2593
2491	=back	2594	=back
2492		2595
2493		2596
2494	=head1 FORK	2597	=head1 FORK
2495		2598
2496	Most event libraries are not fork-safe. The ones who are usually are	2599	Most event libraries are not fork-safe. The ones who are usually are
2497	because they rely on inefficient but fork-safe C<select> or C<poll>	2600	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2498	calls. Only L<EV> is fully fork-aware.	2601	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2602	are usually badly thought-out hacks that are incompatible with fork in
		2603	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2604	continue event-processing in both parent and child (or both, if you know
		2605	what you are doing).
		2606
		2607	This means that, in general, you cannot fork and do event processing in
		2608	the child if the event library was initialised before the fork (which
		2609	usually happens when the first AnyEvent watcher is created, or the library
		2610	is loaded).
2499		2611
2500	If you have to fork, you must either do so I<before> creating your first	2612	If you have to fork, you must either do so I<before> creating your first
2501	watcher OR you must not use AnyEvent at all in the child OR you must do	2613	watcher OR you must not use AnyEvent at all in the child OR you must do
2502	something completely out of the scope of AnyEvent.	2614	something completely out of the scope of AnyEvent.
		2615
		2616	The problem of doing event processing in the parent I<and> the child
		2617	is much more complicated: even for backends that I<are> fork-aware or
		2618	fork-safe, their behaviour is not usually what you want: fork clones all
		2619	watchers, that means all timers, I/O watchers etc. are active in both
		2620	parent and child, which is almost never what you want. USing C<exec>
		2621	to start worker children from some kind of manage rprocess is usually
		2622	preferred, because it is much easier and cleaner, at the expense of having
		2623	to have another binary.
2503		2624
2504		2625
2505	=head1 SECURITY CONSIDERATIONS	2626	=head1 SECURITY CONSIDERATIONS
2506		2627
2507	AnyEvent can be forced to load any event model via	2628	AnyEvent can be forced to load any event model via
…		…
2537	pronounced).	2658	pronounced).
2538		2659
2539		2660
2540	=head1 SEE ALSO	2661	=head1 SEE ALSO
2541		2662
		2663	Tutorial/Introduction: L<AnyEvent::Intro>.
		2664
		2665	FAQ: L<AnyEvent::FAQ>.
		2666
2542	Utility functions: L<AnyEvent::Util>.	2667	Utility functions: L<AnyEvent::Util>.
2543		2668
2544	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2669	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2545	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2670	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2546		2671
2547	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2672	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2548	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2673	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2549	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2674	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2550	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2675	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
…		…
2552	Non-blocking file handles, sockets, TCP clients and	2677	Non-blocking file handles, sockets, TCP clients and
2553	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2678	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2554		2679
2555	Asynchronous DNS: L<AnyEvent::DNS>.	2680	Asynchronous DNS: L<AnyEvent::DNS>.
2556		2681
2557	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2682	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2558	L<Coro::Event>,
2559		2683
2560	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2684	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2561	L<AnyEvent::HTTP>.	2685	L<AnyEvent::HTTP>.
2562		2686
2563		2687
2564	=head1 AUTHOR	2688	=head1 AUTHOR
2565		2689

Diff Legend

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