ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs.
Revision 1.330 by root, Tue Aug 31 00:59:55 2010 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - events independent of event loop implementation	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	event loops.	6	and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18		21
19	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21		24
22	# POSIX signal	25	# POSIX signal
…		…
47		50
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	51	There is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	52	channel, too.
50		53
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	54	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Respository>, at L<http://anyevent.schmorp.de>, for more info.	55	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		56
54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	57	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55		58
56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	59	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
57	nowadays. So what is different about AnyEvent?	60	nowadays. So what is different about AnyEvent?
…		…
73	module users into the same thing by forcing them to use the same event	76	module users into the same thing by forcing them to use the same event
74	model you use.	77	model you use.
75		78
76	For modules like POE or IO::Async (which is a total misnomer as it is	79	For modules like POE or IO::Async (which is a total misnomer as it is
77	actually doing all I/O I<synchronously>...), using them in your module is	80	actually doing all I/O I<synchronously>...), using them in your module is
78	like joining a cult: After you joined, you are dependent on them and you	81	like joining a cult: After you join, you are dependent on them and you
79	cannot use anything else, as they are simply incompatible to everything	82	cannot use anything else, as they are simply incompatible to everything
80	that isn't them. What's worse, all the potential users of your	83	that isn't them. What's worse, all the potential users of your
81	module are I<also> forced to use the same event loop you use.	84	module are I<also> forced to use the same event loop you use.
82		85
83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	86	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	87	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
85	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	88	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
86	your module uses one of those, every user of your module has to use it,	89	your module uses one of those, every user of your module has to use it,
87	too. But if your module uses AnyEvent, it works transparently with all	90	too. But if your module uses AnyEvent, it works transparently with all
88	event models it supports (including stuff like IO::Async, as long as those	91	event models it supports (including stuff like IO::Async, as long as those
89	use one of the supported event loops. It is trivial to add new event loops	92	use one of the supported event loops. It is easy to add new event loops
90	to AnyEvent, too, so it is future-proof).	93	to AnyEvent, too, so it is future-proof).
91		94
92	In addition to being free of having to use I<the one and only true event	95	In addition to being free of having to use I<the one and only true event
93	model>, AnyEvent also is free of bloat and policy: with POE or similar	96	model>, AnyEvent also is free of bloat and policy: with POE or similar
94	modules, you get an enormous amount of code and strict rules you have to	97	modules, you get an enormous amount of code and strict rules you have to
95	follow. AnyEvent, on the other hand, is lean and up to the point, by only	98	follow. AnyEvent, on the other hand, is lean and to the point, by only
96	offering the functionality that is necessary, in as thin as a wrapper as	99	offering the functionality that is necessary, in as thin as a wrapper as
97	technically possible.	100	technically possible.
98		101
99	Of course, AnyEvent comes with a big (and fully optional!) toolbox	102	Of course, AnyEvent comes with a big (and fully optional!) toolbox
100	of useful functionality, such as an asynchronous DNS resolver, 100%	103	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
106	useful) and you want to force your users to use the one and only event	109	useful) and you want to force your users to use the one and only event
107	model, you should I<not> use this module.	110	model, you should I<not> use this module.
108		111
109	=head1 DESCRIPTION	112	=head1 DESCRIPTION
110		113
111	L<AnyEvent> provides an identical interface to multiple event loops. This	114	L<AnyEvent> provides a uniform interface to various event loops. This
112	allows module authors to utilise an event loop without forcing module	115	allows module authors to use event loop functionality without forcing
113	users to use the same event loop (as only a single event loop can coexist	116	module users to use a specific event loop implementation (since more
114	peacefully at any one time).	117	than one event loop cannot coexist peacefully).
115		118
116	The interface itself is vaguely similar, but not identical to the L<Event>	119	The interface itself is vaguely similar, but not identical to the L<Event>
117	module.	120	module.
118		121
119	During the first call of any watcher-creation method, the module tries	122	During the first call of any watcher-creation method, the module tries
…		…
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
144	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
145	explicitly and enjoy the high availability of that event loop :)	149	explicitly and enjoy the high availability of that event loop :)
146		150
…		…
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	});
…		…
180	Note that C<my $w; $w => combination. This is necessary because in Perl,	184	Note that C<my $w; $w => combination. This is necessary because in Perl,
181	my variables are only visible after the statement in which they are	185	my variables are only visible after the statement in which they are
182	declared.	186	declared.
183		187
184	=head2 I/O WATCHERS	188	=head2 I/O WATCHERS
		189
		190	$w = AnyEvent->io (
		191	fh => <filehandle_or_fileno>,
		192	poll => <"r" or "w">,
		193	cb => <callback>,
		194	);
185		195
186	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	196	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187	with the following mandatory key-value pairs as arguments:	197	with the following mandatory key-value pairs as arguments:
188		198
189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	199	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
…		…
204		214
205	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.
206	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
207	underlying file descriptor.	217	underlying file descriptor.
208		218
209	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
210	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
211	handles.	221	handles.
212		222
213	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
214	watcher.	224	watcher.
…		…
219	undef $w;	229	undef $w;
220	});	230	});
221		231
222	=head2 TIME WATCHERS	232	=head2 TIME WATCHERS
223		233
		234	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		235
		236	$w = AnyEvent->timer (
		237	after => <fractional_seconds>,
		238	interval => <fractional_seconds>,
		239	cb => <callback>,
		240	);
		241
224	You can create a time watcher by calling the C<< AnyEvent->timer >>	242	You can create a time watcher by calling the C<< AnyEvent->timer >>
225	method with the following mandatory arguments:	243	method with the following mandatory arguments:
226		244
227	C<after> specifies after how many seconds (fractional values are	245	C<after> specifies after how many seconds (fractional values are
228	supported) the callback should be invoked. C<cb> is the callback to invoke	246	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
230		248
231	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
232	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
233	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
234		252
235	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
236	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
237	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
238	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
239	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.
240		258
241	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
242	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
243	only approximate.	261	only approximate.
244		262
245	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
246		264
247	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
265		283
266	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
267	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
268	"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
269	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
270	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.
271		289
272	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
273	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
274	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)
275	timers.	293	timers.
276		294
277	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
278	AnyEvent API.	296	AnyEvent API.
…		…
300	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
301	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
302		320
303	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
304	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
305	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
306		324
307	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
308	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
309		327
310	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>
311	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
312		330
313	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
314	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
315	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
316	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
317	after three seconds.	335	after three seconds.
318		336
…		…
349	might affect timers and time-outs.	367	might affect timers and time-outs.
350		368
351	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
352	event loop's idea of "current time".	370	event loop's idea of "current time".
353		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).
		378
354	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.
355		380
356	=back	381	=back
357		382
358	=head2 SIGNAL WATCHERS	383	=head2 SIGNAL WATCHERS
		384
		385	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359		386
360	You can watch for signals using a signal watcher, C<signal> is the signal	387	You can watch for signals using a signal watcher, C<signal> is the signal
361	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	388	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362	callback to be invoked whenever a signal occurs.	389	callback to be invoked whenever a signal occurs.
363		390
…		…
380		407
381	Example: exit on SIGINT	408	Example: exit on SIGINT
382		409
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	410	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		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
385	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
386		430
387	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
388	callbacks to signals in a generic way, which is a pity, as you cannot do	432	callbacks to signals in a generic way, which is a pity, as you cannot
389	race-free signal handling in perl. AnyEvent will try to do it's best, but	433	do race-free signal handling in perl, requiring C libraries for
		434	this. AnyEvent will try to do its best, which means in some cases,
390	in some cases, signals will be delayed. The maximum time a signal might	435	signals will be delayed. The maximum time a signal might be delayed is
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	437	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	438	and should be left alone otherwise. This variable determines how often
		439	AnyEvent polls for signals (in case a wake-up was missed). Higher values
394	will cause fewer spurious wake-ups, which is better for power and CPU	440	will cause fewer spurious wake-ups, which is better for power and CPU
		441	saving.
		442
395	saving. All these problems can be avoided by installing the optional	443	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	444	L<Async::Interrupt> module, which works with most event loops. It will not
397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	445	work with inherently broken event loops such as L<Event> or L<Event::Lib>
398	currently, as POE does it's own workaround with one-second latency). With	446	(and not with L<POE> currently, as POE does its own workaround with
399	those, you just have to suffer the delays.	447	one-second latency). For those, you just have to suffer the delays.
400		448
401	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
402		450
		451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		452
403	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.
404		454
405	The child process is specified by the C<pid> argument (if set to C<0>, it	455	The child process is specified by the C<pid> argument (on some backends,
406	watches for any child process exit). The watcher will triggered only when	456	using C<0> watches for any child process exit, on others this will
407	the child process has finished and an exit status is available, not on	457	croak). The watcher will be triggered only when the child process has
408	any trace events (stopped/continued).	458	finished and an exit status is available, not on any trace events
		459	(stopped/continued).
409		460
410	The callback will be called with the pid and exit status (as returned by	461	The callback will be called with the pid and exit status (as returned by
411	waitpid), so unlike other watcher types, you I<can> rely on child watcher	462	waitpid), so unlike other watcher types, you I<can> rely on child watcher
412	callback arguments.	463	callback arguments.
413		464
…		…
454	# do something else, then wait for process exit	505	# do something else, then wait for process exit
455	$done->recv;	506	$done->recv;
456		507
457	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
458		509
459	Sometimes there is a need to do something, but it is not so important	510	$w = AnyEvent->idle (cb => <callback>);
460	to do it instantly, but only when there is nothing better to do. This
461	"nothing better to do" is usually defined to be "no other events need
462	attention by the event loop".
463		511
464	Idle watchers ideally get invoked when the event loop has nothing	512	This will repeatedly invoke the callback after the process becomes idle,
465	better to do, just before it would block the process to wait for new	513	until either the watcher is destroyed or new events have been detected.
466	events. Instead of blocking, the idle watcher is invoked.
467		514
468	Most event loops unfortunately do not really support idle watchers (only	515	Idle watchers are useful when there is a need to do something, but it
		516	is not so important (or wise) to do it instantly. The callback will be
		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.
		523
		524	Unfortunately, most event loops do not really support idle watchers (only
469	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
470	will simply call the callback "from time to time".	526	will simply call the callback "from time to time".
471		527
472	Example: read lines from STDIN, but only process them when the	528	Example: read lines from STDIN, but only process them when the
473	program is otherwise idle:	529	program is otherwise idle:
…		…
489	});	545	});
490	});	546	});
491		547
492	=head2 CONDITION VARIABLES	548	=head2 CONDITION VARIABLES
493		549
		550	$cv = AnyEvent->condvar;
		551
		552	$cv->send (<list>);
		553	my @res = $cv->recv;
		554
494	If you are familiar with some event loops you will know that all of them	555	If you are familiar with some event loops you will know that all of them
495	require you to run some blocking "loop", "run" or similar function that	556	require you to run some blocking "loop", "run" or similar function that
496	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
497		558
498	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
499	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).
500		561
501	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
502	because they represent a condition that must become true.	563	they represent a condition that must become true.
503		564
504	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.
505		566
506	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
507	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
…		…
512	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
513	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
514	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<<
515	->send >> method).	576	->send >> method).
516		577
517	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
518	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:
519	in time where multiple outstanding events have been processed. And yet	580
520	another way to call them is transactions - each condition variable can be	581	=over 4
521	used to represent a transaction, which finishes at some point and delivers	582
522	a result.	583	=item * Condition variables are like callbacks - you can call them (and pass them instead
		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
523		601
524	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
525	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,
526	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
527	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
…		…
540		618
541	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
542	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
543	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
544	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
545	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
546		624
547	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
548	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
549	for the send to occur.	627	for the send to occur.
550		628
551	Example: wait for a timer.	629	Example: wait for a timer.
552		630
553	# wait till the result is ready	631	# condition: "wait till the timer is fired"
554	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
555		633
556	# do something such as adding a timer	634	# create the timer - we could wait for, say
557	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
558	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
559	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
560	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
561	after => 1,	639	after => 1,
562	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
563	);	641	);
564		642
565	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
566	# calls -<send	644	# calls ->send
567	$result_ready->recv;	645	$timer_fired->recv;
568		646
569	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
570	variables are also callable directly.	648	variables are also callable directly.
571		649
572	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
…		…
615	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
616	C<send>.	694	C<send>.
617		695
618	=item $cv->croak ($error)	696	=item $cv->croak ($error)
619		697
620	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
621	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
622		700
623	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
624	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
625	delays the error detetcion, but has the overwhelmign advantage that it	703	delays the error detection, but has the overwhelming advantage that it
626	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
627	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
628	the problem.	706	the problem.
629		707
630	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
631		709
632	=item $cv->end	710	=item $cv->end
…		…
635	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
636	to use a condition variable for the whole process.	714	to use a condition variable for the whole process.
637		715
638	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
639	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
640	>>, 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
641	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
642	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.
643		722
644	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
645	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
646	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).
647		726
…		…
669	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
670	sending.	749	sending.
671		750
672	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
673	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
674	begung can potentially be zero:	753	begun can potentially be zero:
675		754
676	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
677		756
678	my %result;	757	my %result;
679	$cv->begin (sub { $cv->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
680		759
681	for my $host (@list_of_hosts) {	760	for my $host (@list_of_hosts) {
682	$cv->begin;	761	$cv->begin;
683	ping_host_then_call_callback $host, sub {	762	ping_host_then_call_callback $host, sub {
684	$result{$host} = ...;	763	$result{$host} = ...;
…		…
700	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
701	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
702	doesn't execute once).	781	doesn't execute once).
703		782
704	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
705	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
706	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
707	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,
708	call C<end>.	787	call C<end>.
709		788
710	=back	789	=back
…		…
717	=over 4	796	=over 4
718		797
719	=item $cv->recv	798	=item $cv->recv
720		799
721	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
722	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
723	normally.	802	normally.
724		803
725	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
726	will return immediately.	805	will return immediately.
727		806
…		…
744	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
745	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
746	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,
747	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
748		827
749	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
750	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
751	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
752	waits otherwise.	831	waits otherwise.
753		832
754	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
760		839
761	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
762	replaces it before doing so.	841	replaces it before doing so.
763		842
764	The callback will be called when the condition becomes "true", i.e. when	843	The callback will be called when the condition becomes "true", i.e. when
765	C<send> or C<croak> are called, with the only argument being the condition	844	C<send> or C<croak> are called, with the only argument being the
766	variable itself. Calling C<recv> inside the callback or at any later time	845	condition variable itself. If the condition is already true, the
767	is guaranteed not to block.	846	callback is called immediately when it is set. Calling C<recv> inside
		847	the callback or at any later time is guaranteed not to block.
768		848
769	=back	849	=back
770		850
771	=head1 SUPPORTED EVENT LOOPS/BACKENDS	851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
772		852
…		…
775	=over 4	855	=over 4
776		856
777	=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.
778		858
779	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
780	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
781	that, will fall back to its own pure-perl implementation, which is	861	pure-perl implementation, which is available everywhere as it comes with
782	available everywhere as it comes with AnyEvent itself.	862	AnyEvent itself.
783		863
784	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
785	AnyEvent::Impl::Event based on Event, very stable, few glitches.
786	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
787		866
788	=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.
789		868
790	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
791	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
792	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
793	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
794	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.
795		874
		875	AnyEvent::Impl::Event based on Event, very stable, few glitches.
796	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
797	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
798	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
799	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		880	AnyEvent::Impl::Irssi used when running within irssi.
800		881
801	=item Backends with special needs.	882	=item Backends with special needs.
802		883
803	Qt requires the Qt::Application to be instantiated first, but will	884	Qt requires the Qt::Application to be instantiated first, but will
804	otherwise be picked up automatically. As long as the main program	885	otherwise be picked up automatically. As long as the main program
…		…
809		890
810	Support for IO::Async can only be partial, as it is too broken and	891	Support for IO::Async can only be partial, as it is too broken and
811	architecturally limited to even support the AnyEvent API. It also	892	architecturally limited to even support the AnyEvent API. It also
812	is the only event loop that needs the loop to be set explicitly, so	893	is the only event loop that needs the loop to be set explicitly, so
813	it can only be used by a main program knowing about AnyEvent. See	894	it can only be used by a main program knowing about AnyEvent. See
814	L<AnyEvent::Impl::Async> for the gory details.	895	L<AnyEvent::Impl::IOAsync> for the gory details.
815		896
816	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.	897	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
817		898
818	=item Event loops that are indirectly supported via other backends.	899	=item Event loops that are indirectly supported via other backends.
819		900
…		…
847	Contains C<undef> until the first watcher is being created, before the	928	Contains C<undef> until the first watcher is being created, before the
848	backend has been autodetected.	929	backend has been autodetected.
849		930
850	Afterwards it contains the event model that is being used, which is the	931	Afterwards it contains the event model that is being used, which is the
851	name of the Perl class implementing the model. This class is usually one	932	name of the Perl class implementing the model. This class is usually one
852	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the	933	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
853	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it	934	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
854	will be C<urxvt::anyevent>).	935	will be C<urxvt::anyevent>).
855		936
856	=item AnyEvent::detect	937	=item AnyEvent::detect
857		938
858	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	939	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
859	if necessary. You should only call this function right before you would	940	if necessary. You should only call this function right before you would
860	have created an AnyEvent watcher anyway, that is, as late as possible at	941	have created an AnyEvent watcher anyway, that is, as late as possible at
861	runtime, and not e.g. while initialising of your module.	942	runtime, and not e.g. during initialisation of your module.
862		943
863	If you need to do some initialisation before AnyEvent watchers are	944	If you need to do some initialisation before AnyEvent watchers are
864	created, use C<post_detect>.	945	created, use C<post_detect>.
865		946
866	=item $guard = AnyEvent::post_detect { BLOCK }	947	=item $guard = AnyEvent::post_detect { BLOCK }
867		948
868	Arranges for the code block to be executed as soon as the event model is	949	Arranges for the code block to be executed as soon as the event model is
869	autodetected (or immediately if this has already happened).	950	autodetected (or immediately if that has already happened).
870		951
871	The block will be executed I<after> the actual backend has been detected	952	The block will be executed I<after> the actual backend has been detected
872	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been	953	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
873	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do	954	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
874	other initialisations - see the sources of L<AnyEvent::Strict> or	955	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
878	event module detection too early, for example, L<AnyEvent::AIO> creates	959	event module detection too early, for example, L<AnyEvent::AIO> creates
879	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	960	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
880	avoid autodetecting the event module at load time.	961	avoid autodetecting the event module at load time.
881		962
882	If called in scalar or list context, then it creates and returns an object	963	If called in scalar or list context, then it creates and returns an object
883	that automatically removes the callback again when it is destroyed. See	964	that automatically removes the callback again when it is destroyed (or
		965	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
884	L<Coro::BDB> for a case where this is useful.	966	a case where this is useful.
		967
		968	Example: Create a watcher for the IO::AIO module and store it in
		969	C<$WATCHER>, but do so only do so after the event loop is initialised.
		970
		971	our WATCHER;
		972
		973	my $guard = AnyEvent::post_detect {
		974	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		975	};
		976
		977	# the ||= is important in case post_detect immediately runs the block,
		978	# as to not clobber the newly-created watcher. assigning both watcher and
		979	# post_detect guard to the same variable has the advantage of users being
		980	# able to just C<undef $WATCHER> if the watcher causes them grief.
		981
		982	$WATCHER ||= $guard;
885		983
886	=item @AnyEvent::post_detect	984	=item @AnyEvent::post_detect
887		985
888	If there are any code references in this array (you can C<push> to it	986	If there are any code references in this array (you can C<push> to it
889	before or after loading AnyEvent), then they will called directly after	987	before or after loading AnyEvent), then they will be called directly
890	the event loop has been chosen.	988	after the event loop has been chosen.
891		989
892	You should check C<$AnyEvent::MODEL> before adding to this array, though:	990	You should check C<$AnyEvent::MODEL> before adding to this array, though:
893	if it is defined then the event loop has already been detected, and the	991	if it is defined then the event loop has already been detected, and the
894	array will be ignored.	992	array will be ignored.
895		993
896	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	994	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
897	it,as it takes care of these details.	995	it, as it takes care of these details.
898		996
899	This variable is mainly useful for modules that can do something useful	997	This variable is mainly useful for modules that can do something useful
900	when AnyEvent is used and thus want to know when it is initialised, but do	998	when AnyEvent is used and thus want to know when it is initialised, but do
901	not need to even load it by default. This array provides the means to hook	999	not need to even load it by default. This array provides the means to hook
902	into AnyEvent passively, without loading it.	1000	into AnyEvent passively, without loading it.
903		1001
		1002	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1003	together, you could put this into Coro (this is the actual code used by
		1004	Coro to accomplish this):
		1005
		1006	if (defined $AnyEvent::MODEL) {
		1007	# AnyEvent already initialised, so load Coro::AnyEvent
		1008	require Coro::AnyEvent;
		1009	} else {
		1010	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1011	# as soon as it is
		1012	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1013	}
		1014
904	=back	1015	=back
905		1016
906	=head1 WHAT TO DO IN A MODULE	1017	=head1 WHAT TO DO IN A MODULE
907		1018
908	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1019	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
918	because it will stall the whole program, and the whole point of using	1029	because it will stall the whole program, and the whole point of using
919	events is to stay interactive.	1030	events is to stay interactive.
920		1031
921	It is fine, however, to call C<< ->recv >> when the user of your module	1032	It is fine, however, to call C<< ->recv >> when the user of your module
922	requests it (i.e. if you create a http request object ad have a method	1033	requests it (i.e. if you create a http request object ad have a method
923	called C<results> that returns the results, it should call C<< ->recv >>	1034	called C<results> that returns the results, it may call C<< ->recv >>
924	freely, as the user of your module knows what she is doing. always).	1035	freely, as the user of your module knows what she is doing. Always).
925		1036
926	=head1 WHAT TO DO IN THE MAIN PROGRAM	1037	=head1 WHAT TO DO IN THE MAIN PROGRAM
927		1038
928	There will always be a single main program - the only place that should	1039	There will always be a single main program - the only place that should
929	dictate which event model to use.	1040	dictate which event model to use.
930		1041
931	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1042	If the program is not event-based, it need not do anything special, even
932	do anything special (it does not need to be event-based) and let AnyEvent	1043	when it depends on a module that uses an AnyEvent. If the program itself
933	decide which implementation to chose if some module relies on it.	1044	uses AnyEvent, but does not care which event loop is used, all it needs
		1045	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1046	available loop implementation.
934		1047
935	If the main program relies on a specific event model - for example, in	1048	If the main program relies on a specific event model - for example, in
936	Gtk2 programs you have to rely on the Glib module - you should load the	1049	Gtk2 programs you have to rely on the Glib module - you should load the
937	event module before loading AnyEvent or any module that uses it: generally	1050	event module before loading AnyEvent or any module that uses it: generally
938	speaking, you should load it as early as possible. The reason is that	1051	speaking, you should load it as early as possible. The reason is that
939	modules might create watchers when they are loaded, and AnyEvent will	1052	modules might create watchers when they are loaded, and AnyEvent will
940	decide on the event model to use as soon as it creates watchers, and it	1053	decide on the event model to use as soon as it creates watchers, and it
941	might chose the wrong one unless you load the correct one yourself.	1054	might choose the wrong one unless you load the correct one yourself.
942		1055
943	You can chose to use a pure-perl implementation by loading the	1056	You can chose to use a pure-perl implementation by loading the
944	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1057	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
945	everywhere, but letting AnyEvent chose the model is generally better.	1058	everywhere, but letting AnyEvent chose the model is generally better.
946		1059
…		…
964	=head1 OTHER MODULES	1077	=head1 OTHER MODULES
965		1078
966	The following is a non-exhaustive list of additional modules that use	1079	The following is a non-exhaustive list of additional modules that use
967	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1080	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
968	modules and other event loops in the same program. Some of the modules	1081	modules and other event loops in the same program. Some of the modules
969	come with AnyEvent, most are available via CPAN.	1082	come as part of AnyEvent, the others are available via CPAN.
970		1083
971	=over 4	1084	=over 4
972		1085
973	=item L<AnyEvent::Util>	1086	=item L<AnyEvent::Util>
974		1087
975	Contains various utility functions that replace often-used but blocking	1088	Contains various utility functions that replace often-used blocking
976	functions such as C<inet_aton> by event-/callback-based versions.	1089	functions such as C<inet_aton> with event/callback-based versions.
977		1090
978	=item L<AnyEvent::Socket>	1091	=item L<AnyEvent::Socket>
979		1092
980	Provides various utility functions for (internet protocol) sockets,	1093	Provides various utility functions for (internet protocol) sockets,
981	addresses and name resolution. Also functions to create non-blocking tcp	1094	addresses and name resolution. Also functions to create non-blocking tcp
…		…
983		1096
984	=item L<AnyEvent::Handle>	1097	=item L<AnyEvent::Handle>
985		1098
986	Provide read and write buffers, manages watchers for reads and writes,	1099	Provide read and write buffers, manages watchers for reads and writes,
987	supports raw and formatted I/O, I/O queued and fully transparent and	1100	supports raw and formatted I/O, I/O queued and fully transparent and
988	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1101	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
989		1102
990	=item L<AnyEvent::DNS>	1103	=item L<AnyEvent::DNS>
991		1104
992	Provides rich asynchronous DNS resolver capabilities.	1105	Provides rich asynchronous DNS resolver capabilities.
993		1106
		1107	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1108
		1109	Implement event-based interfaces to the protocols of the same name (for
		1110	the curious, IGS is the International Go Server and FCP is the Freenet
		1111	Client Protocol).
		1112
		1113	=item L<AnyEvent::Handle::UDP>
		1114
		1115	Here be danger!
		1116
		1117	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1118	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1119	its use of a stream-based API with a protocol that isn't streamable, that
		1120	the only way to improve it is to delete it.
		1121
		1122	It features data corruption (but typically only under load) and general
		1123	confusion. On top, the author is not only clueless about UDP but also
		1124	fact-resistant - some gems of his understanding: "connect doesn't work
		1125	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1126	packets", "I don't need to implement proper error checking as UDP doesn't
		1127	support error checking" and so on - he doesn't even understand what's
		1128	wrong with his module when it is explained to him.
		1129
994	=item L<AnyEvent::HTTP>	1130	=item L<AnyEvent::DBI>
995		1131
996	A simple-to-use HTTP library that is capable of making a lot of concurrent	1132	Executes L<DBI> requests asynchronously in a proxy process for you,
997	HTTP requests.	1133	notifying you in an event-based way when the operation is finished.
		1134
		1135	=item L<AnyEvent::AIO>
		1136
		1137	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1138	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1139	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1140	file I/O, and much more.
998		1141
999	=item L<AnyEvent::HTTPD>	1142	=item L<AnyEvent::HTTPD>
1000		1143
1001	Provides a simple web application server framework.	1144	A simple embedded webserver.
1002		1145
1003	=item L<AnyEvent::FastPing>	1146	=item L<AnyEvent::FastPing>
1004		1147
1005	The fastest ping in the west.	1148	The fastest ping in the west.
1006
1007	=item L<AnyEvent::DBI>
1008
1009	Executes L<DBI> requests asynchronously in a proxy process.
1010
1011	=item L<AnyEvent::AIO>
1012
1013	Truly asynchronous I/O, should be in the toolbox of every event
1014	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1015	together.
1016
1017	=item L<AnyEvent::BDB>
1018
1019	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1020	L<BDB> and AnyEvent together.
1021
1022	=item L<AnyEvent::GPSD>
1023
1024	A non-blocking interface to gpsd, a daemon delivering GPS information.
1025
1026	=item L<AnyEvent::IRC>
1027
1028	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1029
1030	=item L<AnyEvent::XMPP>
1031
1032	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1033	Net::XMPP2>.
1034
1035	=item L<AnyEvent::IGS>
1036
1037	A non-blocking interface to the Internet Go Server protocol (used by
1038	L<App::IGS>).
1039
1040	=item L<Net::FCP>
1041
1042	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1043	of AnyEvent.
1044
1045	=item L<Event::ExecFlow>
1046
1047	High level API for event-based execution flow control.
1048		1149
1049	=item L<Coro>	1150	=item L<Coro>
1050		1151
1051	Has special support for AnyEvent via L<Coro::AnyEvent>.	1152	Has special support for AnyEvent via L<Coro::AnyEvent>.
1052		1153
…		…
1056		1157
1057	package AnyEvent;	1158	package AnyEvent;
1058		1159
1059	# basically a tuned-down version of common::sense	1160	# basically a tuned-down version of common::sense
1060	sub common_sense {	1161	sub common_sense {
1061	# no warnings	1162	# from common:.sense 1.0
1062	${^WARNING_BITS} ^= ${^WARNING_BITS};	1163	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1063	# use strict vars subs	1164	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1064	$^H |= 0x00000600;	1165	$^H |= 0x00000600;
1065	}	1166	}
1066		1167
1067	BEGIN { AnyEvent::common_sense }	1168	BEGIN { AnyEvent::common_sense }
1068		1169
1069	use Carp ();	1170	use Carp ();
1070		1171
1071	our $VERSION = 4.85;	1172	our $VERSION = '5.271';
1072	our $MODEL;	1173	our $MODEL;
1073		1174
1074	our $AUTOLOAD;	1175	our $AUTOLOAD;
1075	our @ISA;	1176	our @ISA;
1076		1177
1077	our @REGISTRY;	1178	our @REGISTRY;
1078		1179
1079	our $WIN32;
1080
1081	our $VERBOSE;	1180	our $VERBOSE;
1082		1181
1083	BEGIN {	1182	BEGIN {
1084	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1183	require "AnyEvent/constants.pl";
		1184
1085	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1185	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1086		1186
1087	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1187	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1088	if ${^TAINT};	1188	if ${^TAINT};
1089		1189
1090	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1190	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1101	for reverse split /\s*,\s*/,	1201	for reverse split /\s*,\s*/,
1102	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1202	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1103	}	1203	}
1104		1204
1105	my @models = (	1205	my @models = (
1106	[EV:: => AnyEvent::Impl::EV::],	1206	[EV:: => AnyEvent::Impl::EV:: , 1],
1107	[Event:: => AnyEvent::Impl::Event::],
1108	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1207	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1109	# everything below here will not be autoprobed	1208	# everything below here will not (normally) be autoprobed
1110	# as the pureperl backend should work everywhere	1209	# as the pureperl backend should work everywhere
1111	# and is usually faster	1210	# and is usually faster
		1211	[Event:: => AnyEvent::Impl::Event::, 1],
1112	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1212	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1113	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1213	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1214	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1114	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1215	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1115	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1216	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1116	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1217	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1117	[Wx:: => AnyEvent::Impl::POE::],	1218	[Wx:: => AnyEvent::Impl::POE::],
1118	[Prima:: => AnyEvent::Impl::POE::],	1219	[Prima:: => AnyEvent::Impl::POE::],
1119	# IO::Async is just too broken - we would need workarounds for its	1220	# IO::Async is just too broken - we would need workarounds for its
1120	# byzantine signal and broken child handling, among others.	1221	# byzantine signal and broken child handling, among others.
1121	# IO::Async is rather hard to detect, as it doesn't have any	1222	# IO::Async is rather hard to detect, as it doesn't have any
1122	# obvious default class.	1223	# obvious default class.
1123	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1224	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1124	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1225	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1226	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1227	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1126	);	1228	);
1127		1229
1128	our %method = map +($_ => 1),	1230	our %method = map +($_ => 1),
1129	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1231	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1130		1232
1131	our @post_detect;	1233	our @post_detect;
1132		1234
1133	sub post_detect(&) {	1235	sub post_detect(&) {
1134	my ($cb) = @_;	1236	my ($cb) = @_;
1135		1237
1136	if ($MODEL) {
1137	$cb->();
1138
1139	1
1140	} else {
1141	push @post_detect, $cb;	1238	push @post_detect, $cb;
1142		1239
1143	defined wantarray	1240	defined wantarray
1144	? bless \$cb, "AnyEvent::Util::postdetect"	1241	? bless \$cb, "AnyEvent::Util::postdetect"
1145	: ()	1242	: ()
1146	}
1147	}	1243	}
1148		1244
1149	sub AnyEvent::Util::postdetect::DESTROY {	1245	sub AnyEvent::Util::postdetect::DESTROY {
1150	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1246	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1151	}	1247	}
1152		1248
1153	sub detect() {	1249	sub detect() {
		1250	# free some memory
		1251	*detect = sub () { $MODEL };
		1252
		1253	local $!; # for good measure
		1254	local $SIG{__DIE__};
		1255
		1256	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1257	my $model = "AnyEvent::Impl::$1";
		1258	if (eval "require $model") {
		1259	$MODEL = $model;
		1260	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1261	} else {
		1262	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1263	}
		1264	}
		1265
		1266	# check for already loaded models
1154	unless ($MODEL) {	1267	unless ($MODEL) {
1155	local $SIG{__DIE__};	1268	for (@REGISTRY, @models) {
1156		1269	my ($package, $model) = @$_;
1157	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1270	if (${"$package\::VERSION"} > 0) {
1158	my $model = "AnyEvent::Impl::$1";
1159	if (eval "require $model") {	1271	if (eval "require $model") {
1160	$MODEL = $model;	1272	$MODEL = $model;
1161	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1273	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1162	} else {	1274	last;
1163	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1275	}
1164	}	1276	}
1165	}	1277	}
1166		1278
1167	# check for already loaded models
1168	unless ($MODEL) {	1279	unless ($MODEL) {
		1280	# try to autoload a model
1169	for (@REGISTRY, @models) {	1281	for (@REGISTRY, @models) {
1170	my ($package, $model) = @$_;	1282	my ($package, $model, $autoload) = @$_;
		1283	if (
		1284	$autoload
		1285	and eval "require $package"
1171	if (${"$package\::VERSION"} > 0) {	1286	and ${"$package\::VERSION"} > 0
1172	if (eval "require $model") {	1287	and eval "require $model"
		1288	) {
1173	$MODEL = $model;	1289	$MODEL = $model;
1174	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1290	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1175	last;	1291	last;
1176	}
1177	}	1292	}
1178	}	1293	}
1179		1294
1180	unless ($MODEL) {
1181	# try to load a model
1182
1183	for (@REGISTRY, @models) {
1184	my ($package, $model) = @$_;
1185	if (eval "require $package"
1186	and ${"$package\::VERSION"} > 0
1187	and eval "require $model") {
1188	$MODEL = $model;
1189	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1190	last;
1191	}
1192	}
1193
1194	$MODEL	1295	$MODEL
1195	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1296	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1196	}
1197	}	1297	}
1198
1199	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1200
1201	unshift @ISA, $MODEL;
1202
1203	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1204
1205	(shift @post_detect)->() while @post_detect;
1206	}	1298	}
		1299
		1300	@models = (); # free probe data
		1301
		1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1303	unshift @ISA, $MODEL;
		1304
		1305	# now nuke some methods that are overriden by the backend.
		1306	# SUPER is not allowed.
		1307	for (qw(time signal child idle)) {
		1308	undef &{"AnyEvent::Base::$_"}
		1309	if defined &{"$MODEL\::$_"};
		1310	}
		1311
		1312	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1313
		1314	(shift @post_detect)->() while @post_detect;
		1315
		1316	*post_detect = sub(&) {
		1317	shift->();
		1318
		1319	undef
		1320	};
1207		1321
1208	$MODEL	1322	$MODEL
1209	}	1323	}
1210		1324
1211	sub AUTOLOAD {	1325	sub AUTOLOAD {
1212	(my $func = $AUTOLOAD) =~ s/.*://;	1326	(my $func = $AUTOLOAD) =~ s/.*://;
1213		1327
1214	$method{$func}	1328	$method{$func}
1215	or Carp::croak "$func: not a valid method for AnyEvent objects";	1329	or Carp::croak "$func: not a valid AnyEvent class method";
1216		1330
1217	detect unless $MODEL;	1331	detect;
1218		1332
1219	my $class = shift;	1333	my $class = shift;
1220	$class->$func (@_);	1334	$class->$func (@_);
1221	}	1335	}
1222		1336
…		…
1235	# we assume CLOEXEC is already set by perl in all important cases	1349	# we assume CLOEXEC is already set by perl in all important cases
1236		1350
1237	($fh2, $rw)	1351	($fh2, $rw)
1238	}	1352	}
1239		1353
		1354	=head1 SIMPLIFIED AE API
		1355
		1356	Starting with version 5.0, AnyEvent officially supports a second, much
		1357	simpler, API that is designed to reduce the calling, typing and memory
		1358	overhead by using function call syntax and a fixed number of parameters.
		1359
		1360	See the L<AE> manpage for details.
		1361
		1362	=cut
		1363
		1364	package AE;
		1365
		1366	our $VERSION = $AnyEvent::VERSION;
		1367
		1368	# fall back to the main API by default - backends and AnyEvent::Base
		1369	# implementations can overwrite these.
		1370
		1371	sub io($$$) {
		1372	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1373	}
		1374
		1375	sub timer($$$) {
		1376	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1377	}
		1378
		1379	sub signal($$) {
		1380	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1381	}
		1382
		1383	sub child($$) {
		1384	AnyEvent->child (pid => $_[0], cb => $_[1])
		1385	}
		1386
		1387	sub idle($) {
		1388	AnyEvent->idle (cb => $_[0])
		1389	}
		1390
		1391	sub cv(;&) {
		1392	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1393	}
		1394
		1395	sub now() {
		1396	AnyEvent->now
		1397	}
		1398
		1399	sub now_update() {
		1400	AnyEvent->now_update
		1401	}
		1402
		1403	sub time() {
		1404	AnyEvent->time
		1405	}
		1406
1240	package AnyEvent::Base;	1407	package AnyEvent::Base;
1241		1408
1242	# default implementations for many methods	1409	# default implementations for many methods
1243		1410
1244	sub _time {	1411	sub time {
		1412	eval q{ # poor man's autoloading {}
1245	# probe for availability of Time::HiRes	1413	# probe for availability of Time::HiRes
1246	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1414	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1247	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1415	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1248	*_time = \&Time::HiRes::time;	1416	*AE::time = \&Time::HiRes::time;
1249	# if (eval "use POSIX (); (POSIX::times())...	1417	# if (eval "use POSIX (); (POSIX::times())...
1250	} else {	1418	} else {
1251	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1419	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1252	*_time = sub { time }; # epic fail	1420	*AE::time = sub (){ time }; # epic fail
		1421	}
		1422
		1423	*time = sub { AE::time }; # different prototypes
1253	}	1424	};
		1425	die if $@;
1254		1426
1255	&_time	1427	&time
1256	}	1428	}
1257		1429
1258	sub time { _time }	1430	*now = \&time;
1259	sub now { _time }	1431
1260	sub now_update { }	1432	sub now_update { }
1261		1433
1262	# default implementation for ->condvar	1434	# default implementation for ->condvar
1263		1435
1264	sub condvar {	1436	sub condvar {
		1437	eval q{ # poor man's autoloading {}
		1438	*condvar = sub {
1265	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1439	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1440	};
		1441
		1442	*AE::cv = sub (;&) {
		1443	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1444	};
		1445	};
		1446	die if $@;
		1447
		1448	&condvar
1266	}	1449	}
1267		1450
1268	# default implementation for ->signal	1451	# default implementation for ->signal
1269		1452
1270	our $HAVE_ASYNC_INTERRUPT;	1453	our $HAVE_ASYNC_INTERRUPT;
		1454
		1455	sub _have_async_interrupt() {
		1456	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1457	&& eval "use Async::Interrupt 1.02 (); 1")
		1458	unless defined $HAVE_ASYNC_INTERRUPT;
		1459
		1460	$HAVE_ASYNC_INTERRUPT
		1461	}
		1462
1271	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1463	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1272	our (%SIG_ASY, %SIG_ASY_W);	1464	our (%SIG_ASY, %SIG_ASY_W);
1273	our ($SIG_COUNT, $SIG_TW);	1465	our ($SIG_COUNT, $SIG_TW);
1274		1466
1275	sub _signal_exec {
1276	$HAVE_ASYNC_INTERRUPT
1277	? $SIGPIPE_R->drain
1278	: sysread $SIGPIPE_R, my $dummy, 9;
1279
1280	while (%SIG_EV) {
1281	for (keys %SIG_EV) {
1282	delete $SIG_EV{$_};
1283	$_->() for values %{ $SIG_CB{$_} || {} };
1284	}
1285	}
1286	}
1287
1288	# install a dumym wakeupw atcher to reduce signal catching latency	1467	# install a dummy wakeup watcher to reduce signal catching latency
		1468	# used by Impls
1289	sub _sig_add() {	1469	sub _sig_add() {
1290	unless ($SIG_COUNT++) {	1470	unless ($SIG_COUNT++) {
1291	# try to align timer on a full-second boundary, if possible	1471	# try to align timer on a full-second boundary, if possible
1292	my $NOW = AnyEvent->now;	1472	my $NOW = AE::now;
1293		1473
1294	$SIG_TW = AnyEvent->timer (	1474	$SIG_TW = AE::timer
1295	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1475	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1296	interval => $MAX_SIGNAL_LATENCY,	1476	$MAX_SIGNAL_LATENCY,
1297	cb => sub { }, # just for the PERL_ASYNC_CHECK	1477	sub { } # just for the PERL_ASYNC_CHECK
1298	);	1478	;
1299	}	1479	}
1300	}	1480	}
1301		1481
1302	sub _sig_del {	1482	sub _sig_del {
1303	undef $SIG_TW	1483	undef $SIG_TW
1304	unless --$SIG_COUNT;	1484	unless --$SIG_COUNT;
1305	}	1485	}
1306		1486
		1487	our $_sig_name_init; $_sig_name_init = sub {
		1488	eval q{ # poor man's autoloading {}
		1489	undef $_sig_name_init;
		1490
		1491	if (_have_async_interrupt) {
		1492	*sig2num = \&Async::Interrupt::sig2num;
		1493	*sig2name = \&Async::Interrupt::sig2name;
		1494	} else {
		1495	require Config;
		1496
		1497	my %signame2num;
		1498	@signame2num{ split ' ', $Config::Config{sig_name} }
		1499	= split ' ', $Config::Config{sig_num};
		1500
		1501	my @signum2name;
		1502	@signum2name[values %signame2num] = keys %signame2num;
		1503
		1504	*sig2num = sub($) {
		1505	$_[0] > 0 ? shift : $signame2num{+shift}
		1506	};
		1507	*sig2name = sub ($) {
		1508	$_[0] > 0 ? $signum2name[+shift] : shift
		1509	};
		1510	}
		1511	};
		1512	die if $@;
		1513	};
		1514
		1515	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1516	sub sig2name($) { &$_sig_name_init; &sig2name }
		1517
1307	sub _signal {	1518	sub signal {
1308	my (undef, %arg) = @_;	1519	eval q{ # poor man's autoloading {}
		1520	# probe for availability of Async::Interrupt
		1521	if (_have_async_interrupt) {
		1522	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1309		1523
1310	my $signal = uc $arg{signal}	1524	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1311	or Carp::croak "required option 'signal' is missing";	1525	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1312		1526
1313	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1527	} else {
		1528	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1314		1529
1315	if ($HAVE_ASYNC_INTERRUPT) {	1530	if (AnyEvent::WIN32) {
1316	# async::interrupt	1531	require AnyEvent::Util;
1317		1532
1318	$SIG_ASY{$signal} ||= do {	1533	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1319	my $asy = new Async::Interrupt	1534	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1320	cb => sub { undef $SIG_EV{$signal} },	1535	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1321	signal => $signal,	1536	} else {
1322	pipe => [$SIGPIPE_R->filenos],	1537	pipe $SIGPIPE_R, $SIGPIPE_W;
		1538	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
		1539	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1540
		1541	# not strictly required, as $^F is normally 2, but let's make sure...
		1542	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1543	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1323	;	1544	}
1324	$asy->pipe_autodrain (0);
1325		1545
1326	$asy	1546	$SIGPIPE_R
		1547	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1548
		1549	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1550	}
		1551
		1552	*signal = $HAVE_ASYNC_INTERRUPT
		1553	? sub {
		1554	my (undef, %arg) = @_;
		1555
		1556	# async::interrupt
		1557	my $signal = sig2num $arg{signal};
		1558	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1559
		1560	$SIG_ASY{$signal} ||= new Async::Interrupt
		1561	cb => sub { undef $SIG_EV{$signal} },
		1562	signal => $signal,
		1563	pipe => [$SIGPIPE_R->filenos],
		1564	pipe_autodrain => 0,
		1565	;
		1566
		1567	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1568	}
		1569	: sub {
		1570	my (undef, %arg) = @_;
		1571
		1572	# pure perl
		1573	my $signal = sig2name $arg{signal};
		1574	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1575
		1576	$SIG{$signal} ||= sub {
		1577	local $!;
		1578	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1579	undef $SIG_EV{$signal};
		1580	};
		1581
		1582	# can't do signal processing without introducing races in pure perl,
		1583	# so limit the signal latency.
		1584	_sig_add;
		1585
		1586	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1587	}
		1588	;
		1589
		1590	*AnyEvent::Base::signal::DESTROY = sub {
		1591	my ($signal, $cb) = @{$_[0]};
		1592
		1593	_sig_del;
		1594
		1595	delete $SIG_CB{$signal}{$cb};
		1596
		1597	$HAVE_ASYNC_INTERRUPT
		1598	? delete $SIG_ASY{$signal}
		1599	: # delete doesn't work with older perls - they then
		1600	# print weird messages, or just unconditionally exit
		1601	# instead of getting the default action.
		1602	undef $SIG{$signal}
		1603	unless keys %{ $SIG_CB{$signal} };
1327	};	1604	};
1328		1605
1329	} else {	1606	*_signal_exec = sub {
1330	# pure perl	1607	$HAVE_ASYNC_INTERRUPT
		1608	? $SIGPIPE_R->drain
		1609	: sysread $SIGPIPE_R, (my $dummy), 9;
1331		1610
1332	$SIG{$signal} ||= sub {	1611	while (%SIG_EV) {
1333	local $!;	1612	for (keys %SIG_EV) {
1334	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1613	delete $SIG_EV{$_};
1335	undef $SIG_EV{$signal};	1614	$_->() for values %{ $SIG_CB{$_} || {} };
		1615	}
		1616	}
1336	};	1617	};
1337
1338	# can't do signal processing without introducing races in pure perl,
1339	# so limit the signal latency.
1340	_sig_add;
1341	}	1618	};
		1619	die if $@;
1342		1620
1343	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1344	}
1345
1346	sub signal {
1347	# probe for availability of Async::Interrupt
1348	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1349	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1350
1351	$HAVE_ASYNC_INTERRUPT = 1;
1352	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1353	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1354
1355	} else {
1356	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1357
1358	require Fcntl;
1359
1360	if (AnyEvent::WIN32) {
1361	require AnyEvent::Util;
1362
1363	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1364	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1365	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1366	} else {
1367	pipe $SIGPIPE_R, $SIGPIPE_W;
1368	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1369	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1370
1371	# not strictly required, as $^F is normally 2, but let's make sure...
1372	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1373	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374	}
1375
1376	$SIGPIPE_R
1377	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1378
1379	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1380	}
1381
1382	*signal = \&_signal;
1383	&signal	1621	&signal
1384	}
1385
1386	sub AnyEvent::Base::signal::DESTROY {
1387	my ($signal, $cb) = @{$_[0]};
1388
1389	_sig_del;
1390
1391	delete $SIG_CB{$signal}{$cb};
1392
1393	$HAVE_ASYNC_INTERRUPT
1394	? delete $SIG_ASY{$signal}
1395	: # delete doesn't work with older perls - they then
1396	# print weird messages, or just unconditionally exit
1397	# instead of getting the default action.
1398	undef $SIG{$signal}
1399	unless keys %{ $SIG_CB{$signal} };
1400	}	1622	}
1401		1623
1402	# default implementation for ->child	1624	# default implementation for ->child
1403		1625
1404	our %PID_CB;	1626	our %PID_CB;
1405	our $CHLD_W;	1627	our $CHLD_W;
1406	our $CHLD_DELAY_W;	1628	our $CHLD_DELAY_W;
1407	our $WNOHANG;	1629	our $WNOHANG;
1408		1630
1409	sub _sigchld {	1631	# used by many Impl's
1410	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1632	sub _emit_childstatus($$) {
1411	$_->($pid, $?)	1633	my (undef, $rpid, $rstatus) = @_;
		1634
		1635	$_->($rpid, $rstatus)
1412	for values %{ $PID_CB{$pid} || {} },	1636	for values %{ $PID_CB{$rpid} || {} },
1413	values %{ $PID_CB{0} || {} };	1637	values %{ $PID_CB{0} || {} };
1414	}
1415	}	1638	}
1416		1639
1417	sub child {	1640	sub child {
		1641	eval q{ # poor man's autoloading {}
		1642	*_sigchld = sub {
		1643	my $pid;
		1644
		1645	AnyEvent->_emit_childstatus ($pid, $?)
		1646	while ($pid = waitpid -1, $WNOHANG) > 0;
		1647	};
		1648
		1649	*child = sub {
1418	my (undef, %arg) = @_;	1650	my (undef, %arg) = @_;
1419		1651
1420	defined (my $pid = $arg{pid} + 0)	1652	defined (my $pid = $arg{pid} + 0)
1421	or Carp::croak "required option 'pid' is missing";	1653	or Carp::croak "required option 'pid' is missing";
1422		1654
1423	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1655	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1424		1656
1425	# WNOHANG is almost cetrainly 1 everywhere	1657	# WNOHANG is almost cetrainly 1 everywhere
1426	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/	1658	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1427	? 1	1659	? 1
1428	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1660	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1429		1661
1430	unless ($CHLD_W) {	1662	unless ($CHLD_W) {
1431	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1663	$CHLD_W = AE::signal CHLD => \&_sigchld;
1432	# child could be a zombie already, so make at least one round	1664	# child could be a zombie already, so make at least one round
1433	&_sigchld;	1665	&_sigchld;
1434	}	1666	}
1435		1667
1436	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1668	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1437	}	1669	};
1438		1670
1439	sub AnyEvent::Base::child::DESTROY {	1671	*AnyEvent::Base::child::DESTROY = sub {
1440	my ($pid, $cb) = @{$_[0]};	1672	my ($pid, $cb) = @{$_[0]};
1441		1673
1442	delete $PID_CB{$pid}{$cb};	1674	delete $PID_CB{$pid}{$cb};
1443	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1675	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1444		1676
1445	undef $CHLD_W unless keys %PID_CB;	1677	undef $CHLD_W unless keys %PID_CB;
		1678	};
		1679	};
		1680	die if $@;
		1681
		1682	&child
1446	}	1683	}
1447		1684
1448	# idle emulation is done by simply using a timer, regardless	1685	# idle emulation is done by simply using a timer, regardless
1449	# of whether the process is idle or not, and not letting	1686	# of whether the process is idle or not, and not letting
1450	# the callback use more than 50% of the time.	1687	# the callback use more than 50% of the time.
1451	sub idle {	1688	sub idle {
		1689	eval q{ # poor man's autoloading {}
		1690	*idle = sub {
1452	my (undef, %arg) = @_;	1691	my (undef, %arg) = @_;
1453		1692
1454	my ($cb, $w, $rcb) = $arg{cb};	1693	my ($cb, $w, $rcb) = $arg{cb};
1455		1694
1456	$rcb = sub {	1695	$rcb = sub {
1457	if ($cb) {	1696	if ($cb) {
1458	$w = _time;	1697	$w = _time;
1459	&$cb;	1698	&$cb;
1460	$w = _time - $w;	1699	$w = _time - $w;
1461		1700
1462	# never use more then 50% of the time for the idle watcher,	1701	# never use more then 50% of the time for the idle watcher,
1463	# within some limits	1702	# within some limits
1464	$w = 0.0001 if $w < 0.0001;	1703	$w = 0.0001 if $w < 0.0001;
1465	$w = 5 if $w > 5;	1704	$w = 5 if $w > 5;
1466		1705
1467	$w = AnyEvent->timer (after => $w, cb => $rcb);	1706	$w = AE::timer $w, 0, $rcb;
1468	} else {	1707	} else {
1469	# clean up...	1708	# clean up...
1470	undef $w;	1709	undef $w;
1471	undef $rcb;	1710	undef $rcb;
		1711	}
		1712	};
		1713
		1714	$w = AE::timer 0.05, 0, $rcb;
		1715
		1716	bless \\$cb, "AnyEvent::Base::idle"
1472	}	1717	};
		1718
		1719	*AnyEvent::Base::idle::DESTROY = sub {
		1720	undef $${$_[0]};
		1721	};
1473	};	1722	};
		1723	die if $@;
1474		1724
1475	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1725	&idle
1476
1477	bless \\$cb, "AnyEvent::Base::idle"
1478	}
1479
1480	sub AnyEvent::Base::idle::DESTROY {
1481	undef $${$_[0]};
1482	}	1726	}
1483		1727
1484	package AnyEvent::CondVar;	1728	package AnyEvent::CondVar;
1485		1729
1486	our @ISA = AnyEvent::CondVar::Base::;	1730	our @ISA = AnyEvent::CondVar::Base::;
…		…
1534	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1778	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1535	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1779	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1536	}	1780	}
1537		1781
1538	sub cb {	1782	sub cb {
1539	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1783	my $cv = shift;
		1784
		1785	@_
		1786	and $cv->{_ae_cb} = shift
		1787	and $cv->{_ae_sent}
		1788	and (delete $cv->{_ae_cb})->($cv);
		1789
1540	$_[0]{_ae_cb}	1790	$cv->{_ae_cb}
1541	}	1791	}
1542		1792
1543	sub begin {	1793	sub begin {
1544	++$_[0]{_ae_counter};	1794	++$_[0]{_ae_counter};
1545	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1795	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1607	check the arguments passed to most method calls. If it finds any problems,	1857	check the arguments passed to most method calls. If it finds any problems,
1608	it will croak.	1858	it will croak.
1609		1859
1610	In other words, enables "strict" mode.	1860	In other words, enables "strict" mode.
1611		1861
1612	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	1862	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1613	>>, it is definitely recommended to keep it off in production. Keeping	1863	>>, it is definitely recommended to keep it off in production. Keeping
1614	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	1864	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1615	can be very useful, however.	1865	can be very useful, however.
1616		1866
1617	=item C<PERL_ANYEVENT_MODEL>	1867	=item C<PERL_ANYEVENT_MODEL>
…		…
1754	warn "read: $input\n"; # output what has been read	2004	warn "read: $input\n"; # output what has been read
1755	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2005	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1756	},	2006	},
1757	);	2007	);
1758		2008
1759	my $time_watcher; # can only be used once
1760
1761	sub new_timer {
1762	$timer = AnyEvent->timer (after => 1, cb => sub {	2009	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1763	warn "timeout\n"; # print 'timeout' about every second	2010	warn "timeout\n"; # print 'timeout' at most every second
1764	&new_timer; # and restart the time
1765	});	2011	});
1766	}
1767
1768	new_timer; # create first timer
1769		2012
1770	$cv->recv; # wait until user enters /^q/i	2013	$cv->recv; # wait until user enters /^q/i
1771		2014
1772	=head1 REAL-WORLD EXAMPLE	2015	=head1 REAL-WORLD EXAMPLE
1773		2016
…		…
1846		2089
1847	The actual code goes further and collects all errors (C<die>s, exceptions)	2090	The actual code goes further and collects all errors (C<die>s, exceptions)
1848	that occurred during request processing. The C<result> method detects	2091	that occurred during request processing. The C<result> method detects
1849	whether an exception as thrown (it is stored inside the $txn object)	2092	whether an exception as thrown (it is stored inside the $txn object)
1850	and just throws the exception, which means connection errors and other	2093	and just throws the exception, which means connection errors and other
1851	problems get reported tot he code that tries to use the result, not in a	2094	problems get reported to the code that tries to use the result, not in a
1852	random callback.	2095	random callback.
1853		2096
1854	All of this enables the following usage styles:	2097	All of this enables the following usage styles:
1855		2098
1856	1. Blocking:	2099	1. Blocking:
…		…
1904	through AnyEvent. The benchmark creates a lot of timers (with a zero	2147	through AnyEvent. The benchmark creates a lot of timers (with a zero
1905	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2148	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1906	which it is), lets them fire exactly once and destroys them again.	2149	which it is), lets them fire exactly once and destroys them again.
1907		2150
1908	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2151	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1909	distribution.	2152	distribution. It uses the L<AE> interface, which makes a real difference
		2153	for the EV and Perl backends only.
1910		2154
1911	=head3 Explanation of the columns	2155	=head3 Explanation of the columns
1912		2156
1913	I<watcher> is the number of event watchers created/destroyed. Since	2157	I<watcher> is the number of event watchers created/destroyed. Since
1914	different event models feature vastly different performances, each event	2158	different event models feature vastly different performances, each event
…		…
1935	watcher.	2179	watcher.
1936		2180
1937	=head3 Results	2181	=head3 Results
1938		2182
1939	name watchers bytes create invoke destroy comment	2183	name watchers bytes create invoke destroy comment
1940	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2184	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1941	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2185	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1942	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2186	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1943	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2187	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1944	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2188	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1945	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2189	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1946	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2190	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1947	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2191	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1948	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2192	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1949	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2193	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1950	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2194	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1951	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2195	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1952		2196
1953	=head3 Discussion	2197	=head3 Discussion
1954		2198
1955	The benchmark does I<not> measure scalability of the event loop very	2199	The benchmark does I<not> measure scalability of the event loop very
1956	well. For example, a select-based event loop (such as the pure perl one)	2200	well. For example, a select-based event loop (such as the pure perl one)
…		…
1968	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2212	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1969	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2213	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1970	cycles with POE.	2214	cycles with POE.
1971		2215
1972	C<EV> is the sole leader regarding speed and memory use, which are both	2216	C<EV> is the sole leader regarding speed and memory use, which are both
1973	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2217	maximal/minimal, respectively. When using the L<AE> API there is zero
		2218	overhead (when going through the AnyEvent API create is about 5-6 times
		2219	slower, with other times being equal, so still uses far less memory than
1974	far less memory than any other event loop and is still faster than Event	2220	any other event loop and is still faster than Event natively).
1975	natively.
1976		2221
1977	The pure perl implementation is hit in a few sweet spots (both the	2222	The pure perl implementation is hit in a few sweet spots (both the
1978	constant timeout and the use of a single fd hit optimisations in the perl	2223	constant timeout and the use of a single fd hit optimisations in the perl
1979	interpreter and the backend itself). Nevertheless this shows that it	2224	interpreter and the backend itself). Nevertheless this shows that it
1980	adds very little overhead in itself. Like any select-based backend its	2225	adds very little overhead in itself. Like any select-based backend its
…		…
2054	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2299	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2055	(1%) are active. This mirrors the activity of large servers with many	2300	(1%) are active. This mirrors the activity of large servers with many
2056	connections, most of which are idle at any one point in time.	2301	connections, most of which are idle at any one point in time.
2057		2302
2058	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2303	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2059	distribution.	2304	distribution. It uses the L<AE> interface, which makes a real difference
		2305	for the EV and Perl backends only.
2060		2306
2061	=head3 Explanation of the columns	2307	=head3 Explanation of the columns
2062		2308
2063	I<sockets> is the number of sockets, and twice the number of "servers" (as	2309	I<sockets> is the number of sockets, and twice the number of "servers" (as
2064	each server has a read and write socket end).	2310	each server has a read and write socket end).
…		…
2072	a new one that moves the timeout into the future.	2318	a new one that moves the timeout into the future.
2073		2319
2074	=head3 Results	2320	=head3 Results
2075		2321
2076	name sockets create request	2322	name sockets create request
2077	EV 20000 69.01 11.16	2323	EV 20000 62.66 7.99
2078	Perl 20000 73.32 35.87	2324	Perl 20000 68.32 32.64
2079	IOAsync 20000 157.00 98.14 epoll	2325	IOAsync 20000 174.06 101.15 epoll
2080	IOAsync 20000 159.31 616.06 poll	2326	IOAsync 20000 174.67 610.84 poll
2081	Event 20000 212.62 257.32	2327	Event 20000 202.69 242.91
2082	Glib 20000 651.16 1896.30	2328	Glib 20000 557.01 1689.52
2083	POE 20000 349.67 12317.24 uses POE::Loop::Event	2329	POE 20000 341.54 12086.32 uses POE::Loop::Event
2084		2330
2085	=head3 Discussion	2331	=head3 Discussion
2086		2332
2087	This benchmark I<does> measure scalability and overall performance of the	2333	This benchmark I<does> measure scalability and overall performance of the
2088	particular event loop.	2334	particular event loop.
…		…
2214	As you can see, the AnyEvent + EV combination even beats the	2460	As you can see, the AnyEvent + EV combination even beats the
2215	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2461	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2216	backend easily beats IO::Lambda and POE.	2462	backend easily beats IO::Lambda and POE.
2217		2463
2218	And even the 100% non-blocking version written using the high-level (and	2464	And even the 100% non-blocking version written using the high-level (and
2219	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2465	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2220	large margin, even though it does all of DNS, tcp-connect and socket I/O	2466	higher level ("unoptimised") abstractions by a large margin, even though
2221	in a non-blocking way.	2467	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2222		2468
2223	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2469	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2224	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2470	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2225	part of the IO::lambda distribution and were used without any changes.	2471	part of the IO::Lambda distribution and were used without any changes.
2226		2472
2227		2473
2228	=head1 SIGNALS	2474	=head1 SIGNALS
2229		2475
2230	AnyEvent currently installs handlers for these signals:	2476	AnyEvent currently installs handlers for these signals:
…		…
2267	unless defined $SIG{PIPE};	2513	unless defined $SIG{PIPE};
2268		2514
2269	=head1 RECOMMENDED/OPTIONAL MODULES	2515	=head1 RECOMMENDED/OPTIONAL MODULES
2270		2516
2271	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2517	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2272	it's built-in modules) are required to use it.	2518	its built-in modules) are required to use it.
2273		2519
2274	That does not mean that AnyEvent won't take advantage of some additional	2520	That does not mean that AnyEvent won't take advantage of some additional
2275	modules if they are installed.	2521	modules if they are installed.
2276		2522
2277	This section epxlains which additional modules will be used, and how they	2523	This section explains which additional modules will be used, and how they
2278	affect AnyEvent's operetion.	2524	affect AnyEvent's operation.
2279		2525
2280	=over 4	2526	=over 4
2281		2527
2282	=item L<Async::Interrupt>	2528	=item L<Async::Interrupt>
2283		2529
…		…
2288	catch the signals) with some delay (default is 10 seconds, look for	2534	catch the signals) with some delay (default is 10 seconds, look for
2289	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2535	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2290		2536
2291	If this module is available, then it will be used to implement signal	2537	If this module is available, then it will be used to implement signal
2292	catching, which means that signals will not be delayed, and the event loop	2538	catching, which means that signals will not be delayed, and the event loop
2293	will not be interrupted regularly, which is more efficient (And good for	2539	will not be interrupted regularly, which is more efficient (and good for
2294	battery life on laptops).	2540	battery life on laptops).
2295		2541
2296	This affects not just the pure-perl event loop, but also other event loops	2542	This affects not just the pure-perl event loop, but also other event loops
2297	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2543	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2298		2544
…		…
2310	automatic timer adjustments even when no monotonic clock is available,	2556	automatic timer adjustments even when no monotonic clock is available,
2311	can take avdantage of advanced kernel interfaces such as C<epoll> and	2557	can take avdantage of advanced kernel interfaces such as C<epoll> and
2312	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2558	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2313	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2559	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2314		2560
		2561	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2562	then this module will do nothing for you.
		2563
2315	=item L<Guard>	2564	=item L<Guard>
2316		2565
2317	The guard module, when used, will be used to implement	2566	The guard module, when used, will be used to implement
2318	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2567	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2319	lot less memory), but otherwise doesn't affect guard operation much. It is	2568	lot less memory), but otherwise doesn't affect guard operation much. It is
2320	purely used for performance.	2569	purely used for performance.
2321		2570
2322	=item L<JSON> and L<JSON::XS>	2571	=item L<JSON> and L<JSON::XS>
2323		2572
2324	This module is required when you want to read or write JSON data via	2573	One of these modules is required when you want to read or write JSON data
2325	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2574	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2326	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2575	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2327
2328	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2329	installed.
2330		2576
2331	=item L<Net::SSLeay>	2577	=item L<Net::SSLeay>
2332		2578
2333	Implementing TLS/SSL in Perl is certainly interesting, but not very	2579	Implementing TLS/SSL in Perl is certainly interesting, but not very
2334	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2580	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2335	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2581	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2336		2582
2337	=item L<Time::HiRes>	2583	=item L<Time::HiRes>
2338		2584
2339	This module is part of perl since release 5.008. It will be used when the	2585	This module is part of perl since release 5.008. It will be used when the
2340	chosen event library does not come with a timing source on it's own. The	2586	chosen event library does not come with a timing source of its own. The
2341	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2587	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2342	try to use a monotonic clock for timing stability.	2588	try to use a monotonic clock for timing stability.
2343		2589
2344	=back	2590	=back
2345		2591
2346		2592
2347	=head1 FORK	2593	=head1 FORK
2348		2594
2349	Most event libraries are not fork-safe. The ones who are usually are	2595	Most event libraries are not fork-safe. The ones who are usually are
2350	because they rely on inefficient but fork-safe C<select> or C<poll>	2596	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2351	calls. Only L<EV> is fully fork-aware.	2597	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2598	are usually badly thought-out hacks that are incompatible with fork in
		2599	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2600	continue event-processing in both parent and child (or both, if you know
		2601	what you are doing).
		2602
		2603	This means that, in general, you cannot fork and do event processing in
		2604	the child if the event library was initialised before the fork (which
		2605	usually happens when the first AnyEvent watcher is created, or the library
		2606	is loaded).
2352		2607
2353	If you have to fork, you must either do so I<before> creating your first	2608	If you have to fork, you must either do so I<before> creating your first
2354	watcher OR you must not use AnyEvent at all in the child OR you must do	2609	watcher OR you must not use AnyEvent at all in the child OR you must do
2355	something completely out of the scope of AnyEvent.	2610	something completely out of the scope of AnyEvent.
		2611
		2612	The problem of doing event processing in the parent I<and> the child
		2613	is much more complicated: even for backends that I<are> fork-aware or
		2614	fork-safe, their behaviour is not usually what you want: fork clones all
		2615	watchers, that means all timers, I/O watchers etc. are active in both
		2616	parent and child, which is almost never what you want. USing C<exec>
		2617	to start worker children from some kind of manage rprocess is usually
		2618	preferred, because it is much easier and cleaner, at the expense of having
		2619	to have another binary.
2356		2620
2357		2621
2358	=head1 SECURITY CONSIDERATIONS	2622	=head1 SECURITY CONSIDERATIONS
2359		2623
2360	AnyEvent can be forced to load any event model via	2624	AnyEvent can be forced to load any event model via
…		…
2398	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2662	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2399		2663
2400	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2664	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2401	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2665	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2402	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2666	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2403	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2667	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2404		2668
2405	Non-blocking file handles, sockets, TCP clients and	2669	Non-blocking file handles, sockets, TCP clients and
2406	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2670	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2407		2671
2408	Asynchronous DNS: L<AnyEvent::DNS>.	2672	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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