[ViewVC] Diff of: cvs/AnyEvent/README

Comparing AnyEvent/README (file contents):
Revision 1.55 by root, Mon Sep 14 05:05:09 2009 UTC vs.
Revision 1.72 by root, Tue Dec 17 16:43:15 2013 UTC

…		…
1	NAME	1	NAME
2	AnyEvent - the DBI of event loop programming	2	AnyEvent - the DBI of event loop programming
3		3
4	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async,	4	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async,
5	Qt and POE are various supported event loops/environments.	5	Qt, FLTK and POE are various supported event loops/environments.
6		6
7	SYNOPSIS	7	SYNOPSIS
8	use AnyEvent;	8	use AnyEvent;
9		9
		10	# if you prefer function calls, look at the AE manpage for
		11	# an alternative API.
		12
10	# file descriptor readable	13	# file handle or descriptor readable
11	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	14	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
12		15
13	# one-shot or repeating timers	16	# one-shot or repeating timers
14	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	17	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
15	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	18	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
16		19
17	print AnyEvent->now; # prints current event loop time	20	print AnyEvent->now; # prints current event loop time
18	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	21	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
19		22
20	# POSIX signal	23	# POSIX signal
39	This manpage is mainly a reference manual. If you are interested in a	42	This manpage is mainly a reference manual. If you are interested in a
40	tutorial or some gentle introduction, have a look at the AnyEvent::Intro	43	tutorial or some gentle introduction, have a look at the AnyEvent::Intro
41	manpage.	44	manpage.
42		45
43	SUPPORT	46	SUPPORT
		47	An FAQ document is available as AnyEvent::FAQ.
		48
44	There is a mailinglist for discussing all things AnyEvent, and an IRC	49	There also is a mailinglist for discussing all things AnyEvent, and an
45	channel, too.	50	IRC channel, too.
46		51
47	See the AnyEvent project page at the Schmorpforge Ta-Sa Software	52	See the AnyEvent project page at the Schmorpforge Ta-Sa Software
48	Repository, at <http://anyevent.schmorp.de>, for more info.	53	Repository, at <http://anyevent.schmorp.de>, for more info.
49		54
50	WHY YOU SHOULD USE THIS MODULE (OR NOT)	55	WHY YOU SHOULD USE THIS MODULE (OR NOT)
…		…
68	module users into the same thing by forcing them to use the same event	73	module users into the same thing by forcing them to use the same event
69	model you use.	74	model you use.
70		75
71	For modules like POE or IO::Async (which is a total misnomer as it is	76	For modules like POE or IO::Async (which is a total misnomer as it is
72	actually doing all I/O synchronously...), using them in your module is	77	actually doing all I/O synchronously...), using them in your module is
73	like joining a cult: After you joined, you are dependent on them and you	78	like joining a cult: After you join, you are dependent on them and you
74	cannot use anything else, as they are simply incompatible to everything	79	cannot use anything else, as they are simply incompatible to everything
75	that isn't them. What's worse, all the potential users of your module	80	that isn't them. What's worse, all the potential users of your module
76	are also forced to use the same event loop you use.	81	are also forced to use the same event loop you use.
77		82
78	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
79	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
80	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if your	85	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
81	module uses one of those, every user of your module has to use it, too.	86	uses one of those, every user of your module has to use it, too. But if
82	But if your module uses AnyEvent, it works transparently with all event	87	your module uses AnyEvent, it works transparently with all event models
83	models it supports (including stuff like IO::Async, as long as those use	88	it supports (including stuff like IO::Async, as long as those use one of
84	one of the supported event loops. It is trivial to add new event loops	89	the supported event loops. It is easy to add new event loops to
85	to AnyEvent, too, so it is future-proof).	90	AnyEvent, too, so it is future-proof).
86		91
87	In addition to being free of having to use *the one and only true event	92	In addition to being free of having to use *the one and only true event
88	model*, AnyEvent also is free of bloat and policy: with POE or similar	93	model*, AnyEvent also is free of bloat and policy: with POE or similar
89	modules, you get an enormous amount of code and strict rules you have to	94	modules, you get an enormous amount of code and strict rules you have to
90	follow. AnyEvent, on the other hand, is lean and up to the point, by	95	follow. AnyEvent, on the other hand, is lean and to the point, by only
91	only offering the functionality that is necessary, in as thin as a	96	offering the functionality that is necessary, in as thin as a wrapper as
92	wrapper as technically possible.	97	technically possible.
93		98
94	Of course, AnyEvent comes with a big (and fully optional!) toolbox of	99	Of course, AnyEvent comes with a big (and fully optional!) toolbox of
95	useful functionality, such as an asynchronous DNS resolver, 100%	100	useful functionality, such as an asynchronous DNS resolver, 100%
96	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms	101	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
97	such as Windows) and lots of real-world knowledge and workarounds for	102	such as Windows) and lots of real-world knowledge and workarounds for
…		…
100	Now, if you do want lots of policy (this can arguably be somewhat	105	Now, if you do want lots of policy (this can arguably be somewhat
101	useful) and you want to force your users to use the one and only event	106	useful) and you want to force your users to use the one and only event
102	model, you should not use this module.	107	model, you should not use this module.
103		108
104	DESCRIPTION	109	DESCRIPTION
105	AnyEvent provides an identical interface to multiple event loops. This	110	AnyEvent provides a uniform interface to various event loops. This
106	allows module authors to utilise an event loop without forcing module	111	allows module authors to use event loop functionality without forcing
107	users to use the same event loop (as only a single event loop can	112	module users to use a specific event loop implementation (since more
108	coexist peacefully at any one time).	113	than one event loop cannot coexist peacefully).
109		114
110	The interface itself is vaguely similar, but not identical to the Event	115	The interface itself is vaguely similar, but not identical to the Event
111	module.	116	module.
112		117
113	During the first call of any watcher-creation method, the module tries	118	During the first call of any watcher-creation method, the module tries
114	to detect the currently loaded event loop by probing whether one of the	119	to detect the currently loaded event loop by probing whether one of the
115	following modules is already loaded: EV, Event, Glib,	120	following modules is already loaded: EV, AnyEvent::Loop, Event, Glib,
116	AnyEvent::Impl::Perl, Tk, Event::Lib, Qt, POE. The first one found is	121	Tk, Event::Lib, Qt, POE. The first one found is used. If none are
117	used. If none are found, the module tries to load these modules	122	detected, the module tries to load the first four modules in the order
118	(excluding Tk, Event::Lib, Qt and POE as the pure perl adaptor should	123	given; but note that if EV is not available, the pure-perl
119	always succeed) in the order given. The first one that can be	124	AnyEvent::Loop should always work, so the other two are not normally
120	successfully loaded will be used. If, after this, still none could be	125	tried.
121	found, AnyEvent will fall back to a pure-perl event loop, which is not
122	very efficient, but should work everywhere.
123		126
124	Because AnyEvent first checks for modules that are already loaded,	127	Because AnyEvent first checks for modules that are already loaded,
125	loading an event model explicitly before first using AnyEvent will	128	loading an event model explicitly before first using AnyEvent will
126	likely make that model the default. For example:	129	likely make that model the default. For example:
127		130
…		…
129	use AnyEvent;	132	use AnyEvent;
130		133
131	# .. AnyEvent will likely default to Tk	134	# .. AnyEvent will likely default to Tk
132		135
133	The likely means that, if any module loads another event model and	136	The likely means that, if any module loads another event model and
134	starts using it, all bets are off. Maybe you should tell their authors	137	starts using it, all bets are off - this case should be very rare
135	to use AnyEvent so their modules work together with others seamlessly...	138	though, as very few modules hardcode event loops without announcing this
		139	very loudly.
136		140
137	The pure-perl implementation of AnyEvent is called	141	The pure-perl implementation of AnyEvent is called "AnyEvent::Loop".
138	"AnyEvent::Impl::Perl". Like other event modules you can load it	142	Like other event modules you can load it explicitly and enjoy the high
139	explicitly and enjoy the high availability of that event loop :)	143	availability of that event loop :)
140		144
141	WATCHERS	145	WATCHERS
142	AnyEvent has the central concept of a watcher, which is an object that	146	AnyEvent has the central concept of a watcher, which is an object that
143	stores relevant data for each kind of event you are waiting for, such as	147	stores relevant data for each kind of event you are waiting for, such as
144	the callback to call, the file handle to watch, etc.	148	the callback to call, the file handle to watch, etc.
…		…
148	callback when the event occurs (of course, only when the event model is	152	callback when the event occurs (of course, only when the event model is
149	in control).	153	in control).
150		154
151	Note that callbacks must not permanently change global variables	155	Note that callbacks must not permanently change global variables
152	potentially in use by the event loop (such as $_ or $[) and that	156	potentially in use by the event loop (such as $_ or $[) and that
153	callbacks must not "die". The former is good programming practise in	157	callbacks must not "die". The former is good programming practice in
154	Perl and the latter stems from the fact that exception handling differs	158	Perl and the latter stems from the fact that exception handling differs
155	widely between event loops.	159	widely between event loops.
156		160
157	To disable the watcher you have to destroy it (e.g. by setting the	161	To disable a watcher you have to destroy it (e.g. by setting the
158	variable you store it in to "undef" or otherwise deleting all references	162	variable you store it in to "undef" or otherwise deleting all references
159	to it).	163	to it).
160		164
161	All watchers are created by calling a method on the "AnyEvent" class.	165	All watchers are created by calling a method on the "AnyEvent" class.
162		166
163	Many watchers either are used with "recursion" (repeating timers for	167	Many watchers either are used with "recursion" (repeating timers for
164	example), or need to refer to their watcher object in other ways.	168	example), or need to refer to their watcher object in other ways.
165		169
166	An any way to achieve that is this pattern:	170	One way to achieve that is this pattern:
167		171
168	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	172	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
169	# you can use $w here, for example to undef it	173	# you can use $w here, for example to undef it
170	undef $w;	174	undef $w;
171	});	175	});
…		…
202		206
203	The I/O watcher might use the underlying file descriptor or a copy of	207	The I/O watcher might use the underlying file descriptor or a copy of
204	it. You must not close a file handle as long as any watcher is active on	208	it. You must not close a file handle as long as any watcher is active on
205	the underlying file descriptor.	209	the underlying file descriptor.
206		210
207	Some event loops issue spurious readyness notifications, so you should	211	Some event loops issue spurious readiness notifications, so you should
208	always use non-blocking calls when reading/writing from/to your file	212	always use non-blocking calls when reading/writing from/to your file
209	handles.	213	handles.
210		214
211	Example: wait for readability of STDIN, then read a line and disable the	215	Example: wait for readability of STDIN, then read a line and disable the
212	watcher.	216	watcher.
…		…
235		239
236	Although the callback might get passed parameters, their value and	240	Although the callback might get passed parameters, their value and
237	presence is undefined and you cannot rely on them. Portable AnyEvent	241	presence is undefined and you cannot rely on them. Portable AnyEvent
238	callbacks cannot use arguments passed to time watcher callbacks.	242	callbacks cannot use arguments passed to time watcher callbacks.
239		243
240	The callback will normally be invoked once only. If you specify another	244	The callback will normally be invoked only once. If you specify another
241	parameter, "interval", as a strictly positive number (> 0), then the	245	parameter, "interval", as a strictly positive number (> 0), then the
242	callback will be invoked regularly at that interval (in fractional	246	callback will be invoked regularly at that interval (in fractional
243	seconds) after the first invocation. If "interval" is specified with a	247	seconds) after the first invocation. If "interval" is specified with a
244	false value, then it is treated as if it were missing.	248	false value, then it is treated as if it were not specified at all.
245		249
246	The callback will be rescheduled before invoking the callback, but no	250	The callback will be rescheduled before invoking the callback, but no
247	attempt is done to avoid timer drift in most backends, so the interval	251	attempt is made to avoid timer drift in most backends, so the interval
248	is only approximate.	252	is only approximate.
249		253
250	Example: fire an event after 7.7 seconds.	254	Example: fire an event after 7.7 seconds.
251		255
252	my $w = AnyEvent->timer (after => 7.7, cb => sub {	256	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
258		262
259	Example 2: fire an event after 0.5 seconds, then roughly every second.	263	Example 2: fire an event after 0.5 seconds, then roughly every second.
260		264
261	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {	265	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
262	warn "timeout\n";	266	warn "timeout\n";
263	};	267	});
264		268
265	TIMING ISSUES	269	TIMING ISSUES
266	There are two ways to handle timers: based on real time (relative, "fire	270	There are two ways to handle timers: based on real time (relative, "fire
267	in 10 seconds") and based on wallclock time (absolute, "fire at 12	271	in 10 seconds") and based on wallclock time (absolute, "fire at 12
268	o'clock").	272	o'clock").
269		273
270	While most event loops expect timers to specified in a relative way,	274	While most event loops expect timers to specified in a relative way,
271	they use absolute time internally. This makes a difference when your	275	they use absolute time internally. This makes a difference when your
272	clock "jumps", for example, when ntp decides to set your clock backwards	276	clock "jumps", for example, when ntp decides to set your clock backwards
273	from the wrong date of 2014-01-01 to 2008-01-01, a watcher that is	277	from the wrong date of 2014-01-01 to 2008-01-01, a watcher that is
274	supposed to fire "after" a second might actually take six years to	278	supposed to fire "after a second" might actually take six years to
275	finally fire.	279	finally fire.
276		280
277	AnyEvent cannot compensate for this. The only event loop that is	281	AnyEvent cannot compensate for this. The only event loop that is
278	conscious about these issues is EV, which offers both relative	282	conscious of these issues is EV, which offers both relative (ev_timer,
279	(ev_timer, based on true relative time) and absolute (ev_periodic, based	283	based on true relative time) and absolute (ev_periodic, based on
280	on wallclock time) timers.	284	wallclock time) timers.
281		285
282	AnyEvent always prefers relative timers, if available, matching the	286	AnyEvent always prefers relative timers, if available, matching the
283	AnyEvent API.	287	AnyEvent API.
284		288
285	AnyEvent has two additional methods that return the "current time":	289	AnyEvent has two additional methods that return the "current time":
…		…
304	*In almost all cases (in all cases if you don't care), this is the	308	*In almost all cases (in all cases if you don't care), this is the
305	function to call when you want to know the current time.*	309	function to call when you want to know the current time.*
306		310
307	This function is also often faster then "AnyEvent->time", and thus	311	This function is also often faster then "AnyEvent->time", and thus
308	the preferred method if you want some timestamp (for example,	312	the preferred method if you want some timestamp (for example,
309	AnyEvent::Handle uses this to update it's activity timeouts).	313	AnyEvent::Handle uses this to update its activity timeouts).
310		314
311	The rest of this section is only of relevance if you try to be very	315	The rest of this section is only of relevance if you try to be very
312	exact with your timing, you can skip it without bad conscience.	316	exact with your timing; you can skip it without a bad conscience.
313		317
314	For a practical example of when these times differ, consider	318	For a practical example of when these times differ, consider
315	Event::Lib and EV and the following set-up:	319	Event::Lib and EV and the following set-up:
316		320
317	The event loop is running and has just invoked one of your callback	321	The event loop is running and has just invoked one of your callbacks
318	at time=500 (assume no other callbacks delay processing). In your	322	at time=500 (assume no other callbacks delay processing). In your
319	callback, you wait a second by executing "sleep 1" (blocking the	323	callback, you wait a second by executing "sleep 1" (blocking the
320	process for a second) and then (at time=501) you create a relative	324	process for a second) and then (at time=501) you create a relative
321	timer that fires after three seconds.	325	timer that fires after three seconds.
322		326
…		…
343	can get whatever behaviour you want with any event loop, by taking	347	can get whatever behaviour you want with any event loop, by taking
344	the difference between "AnyEvent->time" and "AnyEvent->now" into	348	the difference between "AnyEvent->time" and "AnyEvent->now" into
345	account.	349	account.
346		350
347	AnyEvent->now_update	351	AnyEvent->now_update
348	Some event loops (such as EV or AnyEvent::Impl::Perl) cache the	352	Some event loops (such as EV or AnyEvent::Loop) cache the current
349	current time for each loop iteration (see the discussion of	353	time for each loop iteration (see the discussion of AnyEvent->now,
350	AnyEvent->now, above).	354	above).
351		355
352	When a callback runs for a long time (or when the process sleeps),	356	When a callback runs for a long time (or when the process sleeps),
353	then this "current" time will differ substantially from the real	357	then this "current" time will differ substantially from the real
354	time, which might affect timers and time-outs.	358	time, which might affect timers and time-outs.
355		359
356	When this is the case, you can call this method, which will update	360	When this is the case, you can call this method, which will update
357	the event loop's idea of "current time".	361	the event loop's idea of "current time".
		362
		363	A typical example would be a script in a web server (e.g.
		364	"mod_perl") - when mod_perl executes the script, then the event loop
		365	will have the wrong idea about the "current time" (being potentially
		366	far in the past, when the script ran the last time). In that case
		367	you should arrange a call to "AnyEvent->now_update" each time the
		368	web server process wakes up again (e.g. at the start of your script,
		369	or in a handler).
358		370
359	Note that updating the time might cause some events to be handled.	371	Note that updating the time might cause some events to be handled.
360		372
361	SIGNAL WATCHERS	373	SIGNAL WATCHERS
362	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);	374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
…		…
384		396
385	Example: exit on SIGINT	397	Example: exit on SIGINT
386		398
387	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
388		400
		401	Restart Behaviour
		402	While restart behaviour is up to the event loop implementation, most
		403	will not restart syscalls (that includes Async::Interrupt and AnyEvent's
		404	pure perl implementation).
		405
		406	Safe/Unsafe Signals
		407	Perl signals can be either "safe" (synchronous to opcode handling) or
		408	"unsafe" (asynchronous) - the former might delay signal delivery
		409	indefinitely, the latter might corrupt your memory.
		410
		411	AnyEvent signal handlers are, in addition, synchronous to the event
		412	loop, i.e. they will not interrupt your running perl program but will
		413	only be called as part of the normal event handling (just like timer,
		414	I/O etc. callbacks, too).
		415
389	Signal Races, Delays and Workarounds	416	Signal Races, Delays and Workarounds
390	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	417	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
391	callbacks to signals in a generic way, which is a pity, as you cannot do	418	callbacks to signals in a generic way, which is a pity, as you cannot do
392	race-free signal handling in perl, requiring C libraries for this.	419	race-free signal handling in perl, requiring C libraries for this.
393	AnyEvent will try to do it's best, which means in some cases, signals	420	AnyEvent will try to do its best, which means in some cases, signals
394	will be delayed. The maximum time a signal might be delayed is specified	421	will be delayed. The maximum time a signal might be delayed is 10
395	in $AnyEvent::MAX_SIGNAL_LATENCY (default: 10 seconds). This variable	422	seconds by default, but can be overriden via
396	can be changed only before the first signal watcher is created, and	423	$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} or $AnyEvent::MAX_SIGNAL_LATENCY
397	should be left alone otherwise. This variable determines how often	424	- see the "ENVIRONMENT VARIABLES" section for details.
398	AnyEvent polls for signals (in case a wake-up was missed). Higher values
399	will cause fewer spurious wake-ups, which is better for power and CPU
400	saving.
401		425
402	All these problems can be avoided by installing the optional	426	All these problems can be avoided by installing the optional
403	Async::Interrupt module, which works with most event loops. It will not	427	Async::Interrupt module, which works with most event loops. It will not
404	work with inherently broken event loops such as Event or Event::Lib (and	428	work with inherently broken event loops such as Event or Event::Lib (and
405	not with POE currently, as POE does it's own workaround with one-second
406	latency). For those, you just have to suffer the delays.	429	not with POE currently). For those, you just have to suffer the delays.
407		430
408	CHILD PROCESS WATCHERS	431	CHILD PROCESS WATCHERS
409	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	432	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
410		433
411	You can also watch on a child process exit and catch its exit status.	434	You can also watch for a child process exit and catch its exit status.
412		435
413	The child process is specified by the "pid" argument (one some backends,	436	The child process is specified by the "pid" argument (on some backends,
414	using 0 watches for any child process exit, on others this will croak).	437	using 0 watches for any child process exit, on others this will croak).
415	The watcher will be triggered only when the child process has finished	438	The watcher will be triggered only when the child process has finished
416	and an exit status is available, not on any trace events	439	and an exit status is available, not on any trace events
417	(stopped/continued).	440	(stopped/continued).
418		441
…		…
439	This means you cannot create a child watcher as the very first thing in	462	This means you cannot create a child watcher as the very first thing in
440	an AnyEvent program, you have to create at least one watcher before	463	an AnyEvent program, you have to create at least one watcher before
441	you "fork" the child (alternatively, you can call "AnyEvent::detect").	464	you "fork" the child (alternatively, you can call "AnyEvent::detect").
442		465
443	As most event loops do not support waiting for child events, they will	466	As most event loops do not support waiting for child events, they will
444	be emulated by AnyEvent in most cases, in which the latency and race	467	be emulated by AnyEvent in most cases, in which case the latency and
445	problems mentioned in the description of signal watchers apply.	468	race problems mentioned in the description of signal watchers apply.
446		469
447	Example: fork a process and wait for it	470	Example: fork a process and wait for it
448		471
449	my $done = AnyEvent->condvar;	472	my $done = AnyEvent->condvar;
450		473
		474	# this forks and immediately calls exit in the child. this
		475	# normally has all sorts of bad consequences for your parent,
		476	# so take this as an example only. always fork and exec,
		477	# or call POSIX::_exit, in real code.
451	my $pid = fork or exit 5;	478	my $pid = fork or exit 5;
452		479
453	my $w = AnyEvent->child (	480	my $w = AnyEvent->child (
454	pid => $pid,	481	pid => $pid,
455	cb => sub {	482	cb => sub {
…		…
463	$done->recv;	490	$done->recv;
464		491
465	IDLE WATCHERS	492	IDLE WATCHERS
466	$w = AnyEvent->idle (cb => <callback>);	493	$w = AnyEvent->idle (cb => <callback>);
467		494
468	Sometimes there is a need to do something, but it is not so important to	495	This will repeatedly invoke the callback after the process becomes idle,
469	do it instantly, but only when there is nothing better to do. This	496	until either the watcher is destroyed or new events have been detected.
470	"nothing better to do" is usually defined to be "no other events need
471	attention by the event loop".
472		497
473	Idle watchers ideally get invoked when the event loop has nothing better	498	Idle watchers are useful when there is a need to do something, but it is
474	to do, just before it would block the process to wait for new events.	499	not so important (or wise) to do it instantly. The callback will be
475	Instead of blocking, the idle watcher is invoked.	500	invoked only when there is "nothing better to do", which is usually
		501	defined as "all outstanding events have been handled and no new events
		502	have been detected". That means that idle watchers ideally get invoked
		503	when the event loop has just polled for new events but none have been
		504	detected. Instead of blocking to wait for more events, the idle watchers
		505	will be invoked.
476		506
477	Most event loops unfortunately do not really support idle watchers (only	507	Unfortunately, most event loops do not really support idle watchers
478	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	508	(only EV, Event and Glib do it in a usable fashion) - for the rest,
479	will simply call the callback "from time to time".	509	AnyEvent will simply call the callback "from time to time".
480		510
481	Example: read lines from STDIN, but only process them when the program	511	Example: read lines from STDIN, but only process them when the program
482	is otherwise idle:	512	is otherwise idle:
483		513
484	my @lines; # read data	514	my @lines; # read data
…		…
510		540
511	AnyEvent is slightly different: it expects somebody else to run the	541	AnyEvent is slightly different: it expects somebody else to run the
512	event loop and will only block when necessary (usually when told by the	542	event loop and will only block when necessary (usually when told by the
513	user).	543	user).
514		544
515	The instrument to do that is called a "condition variable", so called	545	The tool to do that is called a "condition variable", so called because
516	because they represent a condition that must become true.	546	they represent a condition that must become true.
517		547
518	Now is probably a good time to look at the examples further below.	548	Now is probably a good time to look at the examples further below.
519		549
520	Condition variables can be created by calling the "AnyEvent->condvar"	550	Condition variables can be created by calling the "AnyEvent->condvar"
521	method, usually without arguments. The only argument pair allowed is	551	method, usually without arguments. The only argument pair allowed is
…		…
526	After creation, the condition variable is "false" until it becomes	556	After creation, the condition variable is "false" until it becomes
527	"true" by calling the "send" method (or calling the condition variable	557	"true" by calling the "send" method (or calling the condition variable
528	as if it were a callback, read about the caveats in the description for	558	as if it were a callback, read about the caveats in the description for
529	the "->send" method).	559	the "->send" method).
530		560
531	Condition variables are similar to callbacks, except that you can	561	Since condition variables are the most complex part of the AnyEvent API,
532	optionally wait for them. They can also be called merge points - points	562	here are some different mental models of what they are - pick the ones
533	in time where multiple outstanding events have been processed. And yet	563	you can connect to:
534	another way to call them is transactions - each condition variable can	564
535	be used to represent a transaction, which finishes at some point and	565	* Condition variables are like callbacks - you can call them (and pass
536	delivers a result. And yet some people know them as "futures" - a	566	them instead of callbacks). Unlike callbacks however, you can also
537	promise to compute/deliver something that you can wait for.	567	wait for them to be called.
		568
		569	* Condition variables are signals - one side can emit or send them,
		570	the other side can wait for them, or install a handler that is
		571	called when the signal fires.
		572
		573	* Condition variables are like "Merge Points" - points in your program
		574	where you merge multiple independent results/control flows into one.
		575
		576	* Condition variables represent a transaction - functions that start
		577	some kind of transaction can return them, leaving the caller the
		578	choice between waiting in a blocking fashion, or setting a callback.
		579
		580	* Condition variables represent future values, or promises to deliver
		581	some result, long before the result is available.
538		582
539	Condition variables are very useful to signal that something has	583	Condition variables are very useful to signal that something has
540	finished, for example, if you write a module that does asynchronous http	584	finished, for example, if you write a module that does asynchronous http
541	requests, then a condition variable would be the ideal candidate to	585	requests, then a condition variable would be the ideal candidate to
542	signal the availability of results. The user can either act when the	586	signal the availability of results. The user can either act when the
…		…
555		599
556	Condition variables are represented by hash refs in perl, and the keys	600	Condition variables are represented by hash refs in perl, and the keys
557	used by AnyEvent itself are all named "_ae_XXX" to make subclassing easy	601	used by AnyEvent itself are all named "_ae_XXX" to make subclassing easy
558	(it is often useful to build your own transaction class on top of	602	(it is often useful to build your own transaction class on top of
559	AnyEvent). To subclass, use "AnyEvent::CondVar" as base class and call	603	AnyEvent). To subclass, use "AnyEvent::CondVar" as base class and call
560	it's "new" method in your own "new" method.	604	its "new" method in your own "new" method.
561		605
562	There are two "sides" to a condition variable - the "producer side"	606	There are two "sides" to a condition variable - the "producer side"
563	which eventually calls "-> send", and the "consumer side", which waits	607	which eventually calls "-> send", and the "consumer side", which waits
564	for the send to occur.	608	for the send to occur.
565		609
566	Example: wait for a timer.	610	Example: wait for a timer.
567		611
568	# wait till the result is ready	612	# condition: "wait till the timer is fired"
569	my $result_ready = AnyEvent->condvar;	613	my $timer_fired = AnyEvent->condvar;
570		614
571	# do something such as adding a timer	615	# create the timer - we could wait for, say
572	# or socket watcher the calls $result_ready->send	616	# a handle becomign ready, or even an
573	# when the "result" is ready.	617	# AnyEvent::HTTP request to finish, but
574	# in this case, we simply use a timer:	618	# in this case, we simply use a timer:
575	my $w = AnyEvent->timer (	619	my $w = AnyEvent->timer (
576	after => 1,	620	after => 1,
577	cb => sub { $result_ready->send },	621	cb => sub { $timer_fired->send },
578	);	622	);
579		623
580	# this "blocks" (while handling events) till the callback	624	# this "blocks" (while handling events) till the callback
581	# calls ->send	625	# calls ->send
582	$result_ready->recv;	626	$timer_fired->recv;
583		627
584	Example: wait for a timer, but take advantage of the fact that condition	628	Example: wait for a timer, but take advantage of the fact that condition
585	variables are also callable directly.	629	variables are also callable directly.
586		630
587	my $done = AnyEvent->condvar;	631	my $done = AnyEvent->condvar;
…		…
625	Condition variables are overloaded so one can call them directly (as	669	Condition variables are overloaded so one can call them directly (as
626	if they were a code reference). Calling them directly is the same as	670	if they were a code reference). Calling them directly is the same as
627	calling "send".	671	calling "send".
628		672
629	$cv->croak ($error)	673	$cv->croak ($error)
630	Similar to send, but causes all call's to "->recv" to invoke	674	Similar to send, but causes all calls to "->recv" to invoke
631	"Carp::croak" with the given error message/object/scalar.	675	"Carp::croak" with the given error message/object/scalar.
632		676
633	This can be used to signal any errors to the condition variable	677	This can be used to signal any errors to the condition variable
634	user/consumer. Doing it this way instead of calling "croak" directly	678	user/consumer. Doing it this way instead of calling "croak" directly
635	delays the error detetcion, but has the overwhelmign advantage that	679	delays the error detection, but has the overwhelming advantage that
636	it diagnoses the error at the place where the result is expected,	680	it diagnoses the error at the place where the result is expected,
637	and not deep in some event clalback without connection to the actual	681	and not deep in some event callback with no connection to the actual
638	code causing the problem.	682	code causing the problem.
639		683
640	$cv->begin ([group callback])	684	$cv->begin ([group callback])
641	$cv->end	685	$cv->end
642	These two methods can be used to combine many transactions/events	686	These two methods can be used to combine many transactions/events
…		…
678	This works because for every event source (EOF on file handle),	722	This works because for every event source (EOF on file handle),
679	there is one call to "begin", so the condvar waits for all calls to	723	there is one call to "begin", so the condvar waits for all calls to
680	"end" before sending.	724	"end" before sending.
681		725
682	The ping example mentioned above is slightly more complicated, as	726	The ping example mentioned above is slightly more complicated, as
683	the there are results to be passwd back, and the number of tasks	727	the there are results to be passed back, and the number of tasks
684	that are begung can potentially be zero:	728	that are begun can potentially be zero:
685		729
686	my $cv = AnyEvent->condvar;	730	my $cv = AnyEvent->condvar;
687		731
688	my %result;	732	my %result;
689	$cv->begin (sub { shift->send (\%result) });	733	$cv->begin (sub { shift->send (\%result) });
…		…
696	};	740	};
697	}	741	}
698		742
699	$cv->end;	743	$cv->end;
700		744
		745	...
		746
		747	my $results = $cv->recv;
		748
701	This code fragment supposedly pings a number of hosts and calls	749	This code fragment supposedly pings a number of hosts and calls
702	"send" after results for all then have have been gathered - in any	750	"send" after results for all then have have been gathered - in any
703	order. To achieve this, the code issues a call to "begin" when it	751	order. To achieve this, the code issues a call to "begin" when it
704	starts each ping request and calls "end" when it has received some	752	starts each ping request and calls "end" when it has received some
705	result for it. Since "begin" and "end" only maintain a counter, the	753	result for it. Since "begin" and "end" only maintain a counter, the
…		…
710	callback to be called once the counter reaches 0, and second, it	758	callback to be called once the counter reaches 0, and second, it
711	ensures that "send" is called even when "no" hosts are being pinged	759	ensures that "send" is called even when "no" hosts are being pinged
712	(the loop doesn't execute once).	760	(the loop doesn't execute once).
713		761
714	This is the general pattern when you "fan out" into multiple (but	762	This is the general pattern when you "fan out" into multiple (but
715	potentially none) subrequests: use an outer "begin"/"end" pair to	763	potentially zero) subrequests: use an outer "begin"/"end" pair to
716	set the callback and ensure "end" is called at least once, and then,	764	set the callback and ensure "end" is called at least once, and then,
717	for each subrequest you start, call "begin" and for each subrequest	765	for each subrequest you start, call "begin" and for each subrequest
718	you finish, call "end".	766	you finish, call "end".
719		767
720	METHODS FOR CONSUMERS	768	METHODS FOR CONSUMERS
721	These methods should only be used by the consuming side, i.e. the code	769	These methods should only be used by the consuming side, i.e. the code
722	awaits the condition.	770	awaits the condition.
723		771
724	$cv->recv	772	$cv->recv
725	Wait (blocking if necessary) until the "->send" or "->croak" methods	773	Wait (blocking if necessary) until the "->send" or "->croak" methods
726	have been called on c<$cv>, while servicing other watchers normally.	774	have been called on $cv, while servicing other watchers normally.
727		775
728	You can only wait once on a condition - additional calls are valid	776	You can only wait once on a condition - additional calls are valid
729	but will return immediately.	777	but will return immediately.
730		778
731	If an error condition has been set by calling "->croak", then this	779	If an error condition has been set by calling "->croak", then this
…		…
734	In list context, all parameters passed to "send" will be returned,	782	In list context, all parameters passed to "send" will be returned,
735	in scalar context only the first one will be returned.	783	in scalar context only the first one will be returned.
736		784
737	Note that doing a blocking wait in a callback is not supported by	785	Note that doing a blocking wait in a callback is not supported by
738	any event loop, that is, recursive invocation of a blocking "->recv"	786	any event loop, that is, recursive invocation of a blocking "->recv"
739	is not allowed, and the "recv" call will "croak" if such a condition	787	is not allowed and the "recv" call will "croak" if such a condition
740	is detected. This condition can be slightly loosened by using	788	is detected. This requirement can be dropped by relying on
741	Coro::AnyEvent, which allows you to do a blocking "->recv" from any	789	Coro::AnyEvent , which allows you to do a blocking "->recv" from any
742	thread that doesn't run the event loop itself.	790	thread that doesn't run the event loop itself. Coro::AnyEvent is
		791	loaded automatically when Coro is used with AnyEvent, so code does
		792	not need to do anything special to take advantage of that: any code
		793	that would normally block your program because it calls "recv", be
		794	executed in an "async" thread instead without blocking other
		795	threads.
743		796
744	Not all event models support a blocking wait - some die in that case	797	Not all event models support a blocking wait - some die in that case
745	(programs might want to do that to stay interactive), so *if you are	798	(programs might want to do that to stay interactive), so *if you are
746	using this from a module, never require a blocking wait*. Instead,	799	using this from a module, never require a blocking wait*. Instead,
747	let the caller decide whether the call will block or not (for	800	let the caller decide whether the call will block or not (for
748	example, by coupling condition variables with some kind of request	801	example, by coupling condition variables with some kind of request
749	results and supporting callbacks so the caller knows that getting	802	results and supporting callbacks so the caller knows that getting
750	the result will not block, while still supporting blocking waits if	803	the result will not block, while still supporting blocking waits if
751	the caller so desires).	804	the caller so desires).
752		805
753	You can ensure that "-recv" never blocks by setting a callback and	806	You can ensure that "->recv" never blocks by setting a callback and
754	only calling "->recv" from within that callback (or at a later	807	only calling "->recv" from within that callback (or at a later
755	time). This will work even when the event loop does not support	808	time). This will work even when the event loop does not support
756	blocking waits otherwise.	809	blocking waits otherwise.
757		810
758	$bool = $cv->ready	811	$bool = $cv->ready
…		…
761		814
762	$cb = $cv->cb ($cb->($cv))	815	$cb = $cv->cb ($cb->($cv))
763	This is a mutator function that returns the callback set and	816	This is a mutator function that returns the callback set and
764	optionally replaces it before doing so.	817	optionally replaces it before doing so.
765		818
766	The callback will be called when the condition becomes (or already	819	The callback will be called when the condition becomes "true", i.e.
767	was) "true", i.e. when "send" or "croak" are called (or were	820	when "send" or "croak" are called, with the only argument being the
768	called), with the only argument being the condition variable itself.	821	condition variable itself. If the condition is already true, the
769	Calling "recv" inside the callback or at any later time is	822	callback is called immediately when it is set. Calling "recv" inside
770	guaranteed not to block.	823	the callback or at any later time is guaranteed not to block.
771		824
772	SUPPORTED EVENT LOOPS/BACKENDS	825	SUPPORTED EVENT LOOPS/BACKENDS
773	The available backend classes are (every class has its own manpage):	826	The available backend classes are (every class has its own manpage):
774		827
775	Backends that are autoprobed when no other event loop can be found.	828	Backends that are autoprobed when no other event loop can be found.
…		…
777	use. If EV is not installed, then AnyEvent will fall back to its own	830	use. If EV is not installed, then AnyEvent will fall back to its own
778	pure-perl implementation, which is available everywhere as it comes	831	pure-perl implementation, which is available everywhere as it comes
779	with AnyEvent itself.	832	with AnyEvent itself.
780		833
781	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	834	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
782	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	835	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
783		836
784	Backends that are transparently being picked up when they are used.	837	Backends that are transparently being picked up when they are used.
785	These will be used when they are currently loaded when the first	838	These will be used if they are already loaded when the first watcher
786	watcher is created, in which case it is assumed that the application	839	is created, in which case it is assumed that the application is
787	is using them. This means that AnyEvent will automatically pick the	840	using them. This means that AnyEvent will automatically pick the
788	right backend when the main program loads an event module before	841	right backend when the main program loads an event module before
789	anything starts to create watchers. Nothing special needs to be done	842	anything starts to create watchers. Nothing special needs to be done
790	by the main program.	843	by the main program.
791		844
792	AnyEvent::Impl::Event based on Event, very stable, few glitches.	845	AnyEvent::Impl::Event based on Event, very stable, few glitches.
793	AnyEvent::Impl::Glib based on Glib, slow but very stable.	846	AnyEvent::Impl::Glib based on Glib, slow but very stable.
794	AnyEvent::Impl::Tk based on Tk, very broken.	847	AnyEvent::Impl::Tk based on Tk, very broken.
795	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	848	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
796	AnyEvent::Impl::POE based on POE, very slow, some limitations.	849	AnyEvent::Impl::POE based on POE, very slow, some limitations.
797	AnyEvent::Impl::Irssi used when running within irssi.	850	AnyEvent::Impl::Irssi used when running within irssi.
		851	AnyEvent::Impl::IOAsync based on IO::Async.
		852	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		853	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
798		854
799	Backends with special needs.	855	Backends with special needs.
800	Qt requires the Qt::Application to be instantiated first, but will	856	Qt requires the Qt::Application to be instantiated first, but will
801	otherwise be picked up automatically. As long as the main program	857	otherwise be picked up automatically. As long as the main program
802	instantiates the application before any AnyEvent watchers are	858	instantiates the application before any AnyEvent watchers are
803	created, everything should just work.	859	created, everything should just work.
804		860
805	AnyEvent::Impl::Qt based on Qt.	861	AnyEvent::Impl::Qt based on Qt.
806		862
807	Support for IO::Async can only be partial, as it is too broken and
808	architecturally limited to even support the AnyEvent API. It also is
809	the only event loop that needs the loop to be set explicitly, so it
810	can only be used by a main program knowing about AnyEvent. See
811	AnyEvent::Impl::Async for the gory details.
812
813	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
814
815	Event loops that are indirectly supported via other backends.	863	Event loops that are indirectly supported via other backends.
816	Some event loops can be supported via other modules:	864	Some event loops can be supported via other modules:
817		865
818	There is no direct support for WxWidgets (Wx) or Prima.	866	There is no direct support for WxWidgets (Wx) or Prima.
819		867
…		…
837	Contains "undef" until the first watcher is being created, before	885	Contains "undef" until the first watcher is being created, before
838	the backend has been autodetected.	886	the backend has been autodetected.
839		887
840	Afterwards it contains the event model that is being used, which is	888	Afterwards it contains the event model that is being used, which is
841	the name of the Perl class implementing the model. This class is	889	the name of the Perl class implementing the model. This class is
842	usually one of the "AnyEvent::Impl:xxx" modules, but can be any	890	usually one of the "AnyEvent::Impl::xxx" modules, but can be any
843	other class in the case AnyEvent has been extended at runtime (e.g.	891	other class in the case AnyEvent has been extended at runtime (e.g.
844	in rxvt-unicode it will be "urxvt::anyevent").	892	in rxvt-unicode it will be "urxvt::anyevent").
845		893
846	AnyEvent::detect	894	AnyEvent::detect
847	Returns $AnyEvent::MODEL, forcing autodetection of the event model	895	Returns $AnyEvent::MODEL, forcing autodetection of the event model
848	if necessary. You should only call this function right before you	896	if necessary. You should only call this function right before you
849	would have created an AnyEvent watcher anyway, that is, as late as	897	would have created an AnyEvent watcher anyway, that is, as late as
850	possible at runtime, and not e.g. while initialising of your module.	898	possible at runtime, and not e.g. during initialisation of your
		899	module.
		900
		901	The effect of calling this function is as if a watcher had been
		902	created (specifically, actions that happen "when the first watcher
		903	is created" happen when calling detetc as well).
851		904
852	If you need to do some initialisation before AnyEvent watchers are	905	If you need to do some initialisation before AnyEvent watchers are
853	created, use "post_detect".	906	created, use "post_detect".
854		907
855	$guard = AnyEvent::post_detect { BLOCK }	908	$guard = AnyEvent::post_detect { BLOCK }
856	Arranges for the code block to be executed as soon as the event	909	Arranges for the code block to be executed as soon as the event
857	model is autodetected (or immediately if this has already happened).	910	model is autodetected (or immediately if that has already happened).
858		911
859	The block will be executed after the actual backend has been	912	The block will be executed after the actual backend has been
860	detected ($AnyEvent::MODEL is set), but before any watchers have	913	detected ($AnyEvent::MODEL is set), but before any watchers have
861	been created, so it is possible to e.g. patch @AnyEvent::ISA or do	914	been created, so it is possible to e.g. patch @AnyEvent::ISA or do
862	other initialisations - see the sources of AnyEvent::Strict or	915	other initialisations - see the sources of AnyEvent::Strict or
…		…
871	object that automatically removes the callback again when it is	924	object that automatically removes the callback again when it is
872	destroyed (or "undef" when the hook was immediately executed). See	925	destroyed (or "undef" when the hook was immediately executed). See
873	AnyEvent::AIO for a case where this is useful.	926	AnyEvent::AIO for a case where this is useful.
874		927
875	Example: Create a watcher for the IO::AIO module and store it in	928	Example: Create a watcher for the IO::AIO module and store it in
876	$WATCHER. Only do so after the event loop is initialised, though.	929	$WATCHER, but do so only do so after the event loop is initialised.
877		930
878	our WATCHER;	931	our WATCHER;
879		932
880	my $guard = AnyEvent::post_detect {	933	my $guard = AnyEvent::post_detect {
881	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	934	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
888		941
889	$WATCHER \|\|= $guard;	942	$WATCHER \|\|= $guard;
890		943
891	@AnyEvent::post_detect	944	@AnyEvent::post_detect
892	If there are any code references in this array (you can "push" to it	945	If there are any code references in this array (you can "push" to it
893	before or after loading AnyEvent), then they will called directly	946	before or after loading AnyEvent), then they will be called directly
894	after the event loop has been chosen.	947	after the event loop has been chosen.
895		948
896	You should check $AnyEvent::MODEL before adding to this array,	949	You should check $AnyEvent::MODEL before adding to this array,
897	though: if it is defined then the event loop has already been	950	though: if it is defined then the event loop has already been
898	detected, and the array will be ignored.	951	detected, and the array will be ignored.
899		952
900	Best use "AnyEvent::post_detect { BLOCK }" when your application	953	Best use "AnyEvent::post_detect { BLOCK }" when your application
901	allows it,as it takes care of these details.	954	allows it, as it takes care of these details.
902		955
903	This variable is mainly useful for modules that can do something	956	This variable is mainly useful for modules that can do something
904	useful when AnyEvent is used and thus want to know when it is	957	useful when AnyEvent is used and thus want to know when it is
905	initialised, but do not need to even load it by default. This array	958	initialised, but do not need to even load it by default. This array
906	provides the means to hook into AnyEvent passively, without loading	959	provides the means to hook into AnyEvent passively, without loading
907	it.	960	it.
908		961
		962	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		963	together, you could put this into Coro (this is the actual code used
		964	by Coro to accomplish this):
		965
		966	if (defined $AnyEvent::MODEL) {
		967	# AnyEvent already initialised, so load Coro::AnyEvent
		968	require Coro::AnyEvent;
		969	} else {
		970	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		971	# as soon as it is
		972	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		973	}
		974
		975	AnyEvent::postpone { BLOCK }
		976	Arranges for the block to be executed as soon as possible, but not
		977	before the call itself returns. In practise, the block will be
		978	executed just before the event loop polls for new events, or shortly
		979	afterwards.
		980
		981	This function never returns anything (to make the "return postpone {
		982	... }" idiom more useful.
		983
		984	To understand the usefulness of this function, consider a function
		985	that asynchronously does something for you and returns some
		986	transaction object or guard to let you cancel the operation. For
		987	example, "AnyEvent::Socket::tcp_connect":
		988
		989	# start a conenction attempt unless one is active
		990	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		991	delete $self->{connect_guard};
		992	...
		993	};
		994
		995	Imagine that this function could instantly call the callback, for
		996	example, because it detects an obvious error such as a negative port
		997	number. Invoking the callback before the function returns causes
		998	problems however: the callback will be called and will try to delete
		999	the guard object. But since the function hasn't returned yet, there
		1000	is nothing to delete. When the function eventually returns it will
		1001	assign the guard object to "$self->{connect_guard}", where it will
		1002	likely never be deleted, so the program thinks it is still trying to
		1003	connect.
		1004
		1005	This is where "AnyEvent::postpone" should be used. Instead of
		1006	calling the callback directly on error:
		1007
		1008	$cb->(undef), return # signal error to callback, BAD!
		1009	if $some_error_condition;
		1010
		1011	It should use "postpone":
		1012
		1013	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1014	if $some_error_condition;
		1015
		1016	AnyEvent::log $level, $msg[, @args]
		1017	Log the given $msg at the given $level.
		1018
		1019	If AnyEvent::Log is not loaded then this function makes a simple
		1020	test to see whether the message will be logged. If the test succeeds
		1021	it will load AnyEvent::Log and call "AnyEvent::Log::log" -
		1022	consequently, look at the AnyEvent::Log documentation for details.
		1023
		1024	If the test fails it will simply return. Right now this happens when
		1025	a numerical loglevel is used and it is larger than the level
		1026	specified via $ENV{PERL_ANYEVENT_VERBOSE}.
		1027
		1028	If you want to sprinkle loads of logging calls around your code,
		1029	consider creating a logger callback with the "AnyEvent::Log::logger"
		1030	function, which can reduce typing, codesize and can reduce the
		1031	logging overhead enourmously.
		1032
909	WHAT TO DO IN A MODULE	1033	WHAT TO DO IN A MODULE
910	As a module author, you should "use AnyEvent" and call AnyEvent methods	1034	As a module author, you should "use AnyEvent" and call AnyEvent methods
911	freely, but you should not load a specific event module or rely on it.	1035	freely, but you should not load a specific event module or rely on it.
912		1036
913	Be careful when you create watchers in the module body - AnyEvent will	1037	Be careful when you create watchers in the module body - AnyEvent will
…		…
920	stall the whole program, and the whole point of using events is to stay	1044	stall the whole program, and the whole point of using events is to stay
921	interactive.	1045	interactive.
922		1046
923	It is fine, however, to call "->recv" when the user of your module	1047	It is fine, however, to call "->recv" when the user of your module
924	requests it (i.e. if you create a http request object ad have a method	1048	requests it (i.e. if you create a http request object ad have a method
925	called "results" that returns the results, it should call "->recv"	1049	called "results" that returns the results, it may call "->recv" freely,
926	freely, as the user of your module knows what she is doing. always).	1050	as the user of your module knows what she is doing. Always).
927		1051
928	WHAT TO DO IN THE MAIN PROGRAM	1052	WHAT TO DO IN THE MAIN PROGRAM
929	There will always be a single main program - the only place that should	1053	There will always be a single main program - the only place that should
930	dictate which event model to use.	1054	dictate which event model to use.
931		1055
932	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1056	If the program is not event-based, it need not do anything special, even
933	do anything special (it does not need to be event-based) and let	1057	when it depends on a module that uses an AnyEvent. If the program itself
934	AnyEvent decide which implementation to chose if some module relies on	1058	uses AnyEvent, but does not care which event loop is used, all it needs
935	it.	1059	to do is "use AnyEvent". In either case, AnyEvent will choose the best
		1060	available loop implementation.
936		1061
937	If the main program relies on a specific event model - for example, in	1062	If the main program relies on a specific event model - for example, in
938	Gtk2 programs you have to rely on the Glib module - you should load the	1063	Gtk2 programs you have to rely on the Glib module - you should load the
939	event module before loading AnyEvent or any module that uses it:	1064	event module before loading AnyEvent or any module that uses it:
940	generally speaking, you should load it as early as possible. The reason	1065	generally speaking, you should load it as early as possible. The reason
941	is that modules might create watchers when they are loaded, and AnyEvent	1066	is that modules might create watchers when they are loaded, and AnyEvent
942	will decide on the event model to use as soon as it creates watchers,	1067	will decide on the event model to use as soon as it creates watchers,
943	and it might chose the wrong one unless you load the correct one	1068	and it might choose the wrong one unless you load the correct one
944	yourself.	1069	yourself.
945		1070
946	You can chose to use a pure-perl implementation by loading the	1071	You can chose to use a pure-perl implementation by loading the
947	"AnyEvent::Impl::Perl" module, which gives you similar behaviour	1072	"AnyEvent::Loop" module, which gives you similar behaviour everywhere,
948	everywhere, but letting AnyEvent chose the model is generally better.	1073	but letting AnyEvent chose the model is generally better.
949		1074
950	MAINLOOP EMULATION	1075	MAINLOOP EMULATION
951	Sometimes (often for short test scripts, or even standalone programs who	1076	Sometimes (often for short test scripts, or even standalone programs who
952	only want to use AnyEvent), you do not want to run a specific event	1077	only want to use AnyEvent), you do not want to run a specific event
953	loop.	1078	loop.
…		…
965		1090
966	OTHER MODULES	1091	OTHER MODULES
967	The following is a non-exhaustive list of additional modules that use	1092	The following is a non-exhaustive list of additional modules that use
968	AnyEvent as a client and can therefore be mixed easily with other	1093	AnyEvent as a client and can therefore be mixed easily with other
969	AnyEvent modules and other event loops in the same program. Some of the	1094	AnyEvent modules and other event loops in the same program. Some of the
970	modules come with AnyEvent, most are available via CPAN.	1095	modules come as part of AnyEvent, the others are available via CPAN (see
		1096	<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for a longer
		1097	non-exhaustive list), and the list is heavily biased towards modules of
		1098	the AnyEvent author himself :)
971		1099
972	AnyEvent::Util	1100	AnyEvent::Util (part of the AnyEvent distribution)
973	Contains various utility functions that replace often-used but	1101	Contains various utility functions that replace often-used blocking
974	blocking functions such as "inet_aton" by event-/callback-based	1102	functions such as "inet_aton" with event/callback-based versions.
975	versions.
976		1103
977	AnyEvent::Socket	1104	AnyEvent::Socket (part of the AnyEvent distribution)
978	Provides various utility functions for (internet protocol) sockets,	1105	Provides various utility functions for (internet protocol) sockets,
979	addresses and name resolution. Also functions to create non-blocking	1106	addresses and name resolution. Also functions to create non-blocking
980	tcp connections or tcp servers, with IPv6 and SRV record support and	1107	tcp connections or tcp servers, with IPv6 and SRV record support and
981	more.	1108	more.
982		1109
983	AnyEvent::Handle	1110	AnyEvent::Handle (part of the AnyEvent distribution)
984	Provide read and write buffers, manages watchers for reads and	1111	Provide read and write buffers, manages watchers for reads and
985	writes, supports raw and formatted I/O, I/O queued and fully	1112	writes, supports raw and formatted I/O, I/O queued and fully
986	transparent and non-blocking SSL/TLS (via AnyEvent::TLS.	1113	transparent and non-blocking SSL/TLS (via AnyEvent::TLS).
987		1114
988	AnyEvent::DNS	1115	AnyEvent::DNS (part of the AnyEvent distribution)
989	Provides rich asynchronous DNS resolver capabilities.	1116	Provides rich asynchronous DNS resolver capabilities.
990		1117
991	AnyEvent::HTTP	1118	AnyEvent::HTTP, AnyEvent::IRC, AnyEvent::XMPP, AnyEvent::GPSD,
992	A simple-to-use HTTP library that is capable of making a lot of	1119	AnyEvent::IGS, AnyEvent::FCP
993	concurrent HTTP requests.	1120	Implement event-based interfaces to the protocols of the same name
		1121	(for the curious, IGS is the International Go Server and FCP is the
		1122	Freenet Client Protocol).
994		1123
		1124	AnyEvent::AIO (part of the AnyEvent distribution)
		1125	Truly asynchronous (as opposed to non-blocking) I/O, should be in
		1126	the toolbox of every event programmer. AnyEvent::AIO transparently
		1127	fuses IO::AIO and AnyEvent together, giving AnyEvent access to
		1128	event-based file I/O, and much more.
		1129
		1130	AnyEvent::Fork, AnyEvent::Fork::RPC, AnyEvent::Fork::Pool,
		1131	AnyEvent::Fork::Remote
		1132	These let you safely fork new subprocesses, either locally or
		1133	remotely (e.g.v ia ssh), using some RPC protocol or not, without the
		1134	limitations normally imposed by fork (AnyEvent works fine for
		1135	example). Dynamically-resized worker pools are obviously included as
		1136	well.
		1137
		1138	And they are quite tiny and fast as well - "abusing" AnyEvent::Fork
		1139	just to exec external programs can easily beat using "fork" and
		1140	"exec" (or even "system") in most programs.
		1141
		1142	AnyEvent::Filesys::Notify
		1143	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1144	path changes (e.g. "watch this directory for new files", "watch this
		1145	file for changes"). The AnyEvent::Filesys::Notify module promises to
		1146	do just that in a portbale fashion, supporting inotify on GNU/Linux
		1147	and some weird, without doubt broken, stuff on OS X to monitor
		1148	files. It can fall back to blocking scans at regular intervals
		1149	transparently on other platforms, so it's about as portable as it
		1150	gets.
		1151
		1152	(I haven't used it myself, but it seems the biggest problem with it
		1153	is it quite bad performance).
		1154
995	AnyEvent::HTTPD	1155	AnyEvent::DBI
996	Provides a simple web application server framework.	1156	Executes DBI requests asynchronously in a proxy process for you,
		1157	notifying you in an event-based way when the operation is finished.
997		1158
998	AnyEvent::FastPing	1159	AnyEvent::FastPing
999	The fastest ping in the west.	1160	The fastest ping in the west.
1000		1161
1001	AnyEvent::DBI
1002	Executes DBI requests asynchronously in a proxy process.
1003
1004	AnyEvent::AIO
1005	Truly asynchronous I/O, should be in the toolbox of every event
1006	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
1007	together.
1008
1009	AnyEvent::BDB
1010	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently
1011	fuses BDB and AnyEvent together.
1012
1013	AnyEvent::GPSD
1014	A non-blocking interface to gpsd, a daemon delivering GPS
1015	information.
1016
1017	AnyEvent::IRC
1018	AnyEvent based IRC client module family (replacing the older
1019	Net::IRC3).
1020
1021	AnyEvent::XMPP
1022	AnyEvent based XMPP (Jabber protocol) module family (replacing the
1023	older Net::XMPP2>.
1024
1025	AnyEvent::IGS
1026	A non-blocking interface to the Internet Go Server protocol (used by
1027	App::IGS).
1028
1029	Net::FCP
1030	AnyEvent-based implementation of the Freenet Client Protocol,
1031	birthplace of AnyEvent.
1032
1033	Event::ExecFlow
1034	High level API for event-based execution flow control.
1035
1036	Coro	1162	Coro
1037	Has special support for AnyEvent via Coro::AnyEvent.	1163	Has special support for AnyEvent via Coro::AnyEvent, which allows
		1164	you to simply invert the flow control - don't call us, we will call
		1165	you:
		1166
		1167	async {
		1168	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1169	print "5 seconds later!\n";
		1170
		1171	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1172	my $line = <STDIN>; # works for ttys
		1173
		1174	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1175	my ($body, $hdr) = Coro::rouse_wait;
		1176	};
1038		1177
1039	SIMPLIFIED AE API	1178	SIMPLIFIED AE API
1040	Starting with version 5.0, AnyEvent officially supports a second, much	1179	Starting with version 5.0, AnyEvent officially supports a second, much
1041	simpler, API that is designed to reduce the calling, typing and memory	1180	simpler, API that is designed to reduce the calling, typing and memory
1042	overhead.	1181	overhead by using function call syntax and a fixed number of parameters.
1043		1182
1044	See the AE manpage for details.	1183	See the AE manpage for details.
1045		1184
1046	ERROR AND EXCEPTION HANDLING	1185	ERROR AND EXCEPTION HANDLING
1047	In general, AnyEvent does not do any error handling - it relies on the	1186	In general, AnyEvent does not do any error handling - it relies on the
…		…
1058	The pure perl event loop simply re-throws the exception (usually within	1197	The pure perl event loop simply re-throws the exception (usually within
1059	"condvar->recv"), the Event and EV modules call "$Event/EV::DIED->()",	1198	"condvar->recv"), the Event and EV modules call "$Event/EV::DIED->()",
1060	Glib uses "install_exception_handler" and so on.	1199	Glib uses "install_exception_handler" and so on.
1061		1200
1062	ENVIRONMENT VARIABLES	1201	ENVIRONMENT VARIABLES
1063	The following environment variables are used by this module or its	1202	AnyEvent supports a number of environment variables that tune the
1064	submodules.	1203	runtime behaviour. They are usually evaluated when AnyEvent is loaded,
		1204	initialised, or a submodule that uses them is loaded. Many of them also
		1205	cause AnyEvent to load additional modules - for example,
		1206	"PERL_ANYEVENT_DEBUG_WRAP" causes the AnyEvent::Debug module to be
		1207	loaded.
1065		1208
1066	Note that AnyEvent will remove all environment variables starting with	1209	All the environment variables documented here start with
1067	"PERL_ANYEVENT_" from %ENV when it is loaded while taint mode is	1210	"PERL_ANYEVENT_", which is what AnyEvent considers its own namespace.
1068	enabled.	1211	Other modules are encouraged (but by no means required) to use
		1212	"PERL_ANYEVENT_SUBMODULE" if they have registered the
		1213	AnyEvent::Submodule namespace on CPAN, for any submodule. For example,
		1214	AnyEvent::HTTP could be expected to use "PERL_ANYEVENT_HTTP_PROXY" (it
		1215	should not access env variables starting with "AE_", see below).
		1216
		1217	All variables can also be set via the "AE_" prefix, that is, instead of
		1218	setting "PERL_ANYEVENT_VERBOSE" you can also set "AE_VERBOSE". In case
		1219	there is a clash btween anyevent and another program that uses
		1220	"AE_something" you can set the corresponding "PERL_ANYEVENT_something"
		1221	variable to the empty string, as those variables take precedence.
		1222
		1223	When AnyEvent is first loaded, it copies all "AE_xxx" env variables to
		1224	their "PERL_ANYEVENT_xxx" counterpart unless that variable already
		1225	exists. If taint mode is on, then AnyEvent will remove all environment
		1226	variables starting with "PERL_ANYEVENT_" from %ENV (or replace them with
		1227	"undef" or the empty string, if the corresaponding "AE_" variable is
		1228	set).
		1229
		1230	The exact algorithm is currently:
		1231
		1232	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		1233	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		1234	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		1235
		1236	This ensures that child processes will not see the "AE_" variables.
		1237
		1238	The following environment variables are currently known to AnyEvent:
1069		1239
1070	"PERL_ANYEVENT_VERBOSE"	1240	"PERL_ANYEVENT_VERBOSE"
1071	By default, AnyEvent will be completely silent except in fatal	1241	By default, AnyEvent will log messages with loglevel 4 ("error") or
1072	conditions. You can set this environment variable to make AnyEvent	1242	higher (see AnyEvent::Log). You can set this environment variable to
1073	more talkative.	1243	a numerical loglevel to make AnyEvent more (or less) talkative.
1074		1244
		1245	If you want to do more than just set the global logging level you
		1246	should have a look at "PERL_ANYEVENT_LOG", which allows much more
		1247	complex specifications.
		1248
		1249	When set to 0 ("off"), then no messages whatsoever will be logged
		1250	with everything else at defaults.
		1251
1075	When set to 1 or higher, causes AnyEvent to warn about unexpected	1252	When set to 5 or higher ("warn"), AnyEvent warns about unexpected
1076	conditions, such as not being able to load the event model specified	1253	conditions, such as not being able to load the event model specified
1077	by "PERL_ANYEVENT_MODEL".	1254	by "PERL_ANYEVENT_MODEL", or a guard callback throwing an exception
		1255	- this is the minimum recommended level for use during development.
1078		1256
1079	When set to 2 or higher, cause AnyEvent to report to STDERR which	1257	When set to 7 or higher (info), AnyEvent reports which event model
1080	event model it chooses.	1258	it chooses.
1081		1259
1082	When set to 8 or higher, then AnyEvent will report extra information	1260	When set to 8 or higher (debug), then AnyEvent will report extra
1083	on which optional modules it loads and how it implements certain	1261	information on which optional modules it loads and how it implements
1084	features.	1262	certain features.
		1263
		1264	"PERL_ANYEVENT_LOG"
		1265	Accepts rather complex logging specifications. For example, you
		1266	could log all "debug" messages of some module to stderr, warnings
		1267	and above to stderr, and errors and above to syslog, with:
		1268
		1269	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		1270
		1271	For the rather extensive details, see AnyEvent::Log.
		1272
		1273	This variable is evaluated when AnyEvent (or AnyEvent::Log) is
		1274	loaded, so will take effect even before AnyEvent has initialised
		1275	itself.
		1276
		1277	Note that specifying this environment variable causes the
		1278	AnyEvent::Log module to be loaded, while "PERL_ANYEVENT_VERBOSE"
		1279	does not, so only using the latter saves a few hundred kB of memory
		1280	unless a module explicitly needs the extra features of
		1281	AnyEvent::Log.
1085		1282
1086	"PERL_ANYEVENT_STRICT"	1283	"PERL_ANYEVENT_STRICT"
1087	AnyEvent does not do much argument checking by default, as thorough	1284	AnyEvent does not do much argument checking by default, as thorough
1088	argument checking is very costly. Setting this variable to a true	1285	argument checking is very costly. Setting this variable to a true
1089	value will cause AnyEvent to load "AnyEvent::Strict" and then to	1286	value will cause AnyEvent to load "AnyEvent::Strict" and then to
1090	thoroughly check the arguments passed to most method calls. If it	1287	thoroughly check the arguments passed to most method calls. If it
1091	finds any problems, it will croak.	1288	finds any problems, it will croak.
1092		1289
1093	In other words, enables "strict" mode.	1290	In other words, enables "strict" mode.
1094		1291
1095	Unlike "use strict" (or it's modern cousin, "use common::sense", it	1292	Unlike "use strict" (or its modern cousin, "use common::sense", it
1096	is definitely recommended to keep it off in production. Keeping	1293	is definitely recommended to keep it off in production. Keeping
1097	"PERL_ANYEVENT_STRICT=1" in your environment while developing	1294	"PERL_ANYEVENT_STRICT=1" in your environment while developing
1098	programs can be very useful, however.	1295	programs can be very useful, however.
1099		1296
		1297	"PERL_ANYEVENT_DEBUG_SHELL"
		1298	If this env variable is nonempty, then its contents will be
		1299	interpreted by "AnyEvent::Socket::parse_hostport" and
		1300	"AnyEvent::Debug::shell" (after replacing every occurance of $$ by
		1301	the process pid). The shell object is saved in
		1302	$AnyEvent::Debug::SHELL.
		1303
		1304	This happens when the first watcher is created.
		1305
		1306	For example, to bind a debug shell on a unix domain socket in
		1307	/tmp/debug<pid>.sock, you could use this:
		1308
		1309	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		1310	# connect with e.g.: socat readline /tmp/debug123.sock
		1311
		1312	Or to bind to tcp port 4545 on localhost:
		1313
		1314	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		1315	# connect with e.g.: telnet localhost 4545
		1316
		1317	Note that creating sockets in /tmp or on localhost is very unsafe on
		1318	multiuser systems.
		1319
		1320	"PERL_ANYEVENT_DEBUG_WRAP"
		1321	Can be set to 0, 1 or 2 and enables wrapping of all watchers for
		1322	debugging purposes. See "AnyEvent::Debug::wrap" for details.
		1323
1100	"PERL_ANYEVENT_MODEL"	1324	"PERL_ANYEVENT_MODEL"
1101	This can be used to specify the event model to be used by AnyEvent,	1325	This can be used to specify the event model to be used by AnyEvent,
1102	before auto detection and -probing kicks in. It must be a string	1326	before auto detection and -probing kicks in.
1103	consisting entirely of ASCII letters. The string "AnyEvent::Impl::"	1327
1104	gets prepended and the resulting module name is loaded and if the	1328	It normally is a string consisting entirely of ASCII letters (e.g.
1105	load was successful, used as event model. If it fails to load	1329	"EV" or "IOAsync"). The string "AnyEvent::Impl::" gets prepended and
		1330	the resulting module name is loaded and - if the load was successful
		1331	- used as event model backend. If it fails to load then AnyEvent
1106	AnyEvent will proceed with auto detection and -probing.	1332	will proceed with auto detection and -probing.
1107		1333
1108	This functionality might change in future versions.	1334	If the string ends with "::" instead (e.g. "AnyEvent::Impl::EV::")
		1335	then nothing gets prepended and the module name is used as-is (hint:
		1336	"::" at the end of a string designates a module name and quotes it
		1337	appropriately).
1109		1338
1110	For example, to force the pure perl model (AnyEvent::Impl::Perl) you	1339	For example, to force the pure perl model (AnyEvent::Loop::Perl) you
1111	could start your program like this:	1340	could start your program like this:
1112		1341
1113	PERL_ANYEVENT_MODEL=Perl perl ...	1342	PERL_ANYEVENT_MODEL=Perl perl ...
		1343
		1344	"PERL_ANYEVENT_IO_MODEL"
		1345	The current file I/O model - see AnyEvent::IO for more info.
		1346
		1347	At the moment, only "Perl" (small, pure-perl, synchronous) and
		1348	"IOAIO" (truly asynchronous) are supported. The default is "IOAIO"
		1349	if AnyEvent::AIO can be loaded, otherwise it is "Perl".
1114		1350
1115	"PERL_ANYEVENT_PROTOCOLS"	1351	"PERL_ANYEVENT_PROTOCOLS"
1116	Used by both AnyEvent::DNS and AnyEvent::Socket to determine	1352	Used by both AnyEvent::DNS and AnyEvent::Socket to determine
1117	preferences for IPv4 or IPv6. The default is unspecified (and might	1353	preferences for IPv4 or IPv6. The default is unspecified (and might
1118	change, or be the result of auto probing).	1354	change, or be the result of auto probing).
…		…
1132	"PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to	1368	"PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to
1133	resolve or contact IPv6 addresses.	1369	resolve or contact IPv6 addresses.
1134	"PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4" support either IPv4 or IPv6, but	1370	"PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4" support either IPv4 or IPv6, but
1135	prefer IPv6 over IPv4.	1371	prefer IPv6 over IPv4.
1136		1372
		1373	"PERL_ANYEVENT_HOSTS"
		1374	This variable, if specified, overrides the /etc/hosts file used by
		1375	AnyEvent::Socket"::resolve_sockaddr", i.e. hosts aliases will be
		1376	read from that file instead.
		1377
1137	"PERL_ANYEVENT_EDNS0"	1378	"PERL_ANYEVENT_EDNS0"
1138	Used by AnyEvent::DNS to decide whether to use the EDNS0 extension	1379	Used by AnyEvent::DNS to decide whether to use the EDNS0 extension
1139	for DNS. This extension is generally useful to reduce DNS traffic,	1380	for DNS. This extension is generally useful to reduce DNS traffic,
1140	but some (broken) firewalls drop such DNS packets, which is why it	1381	especially when DNSSEC is involved, but some (broken) firewalls drop
1141	is off by default.	1382	such DNS packets, which is why it is off by default.
1142		1383
1143	Setting this variable to 1 will cause AnyEvent::DNS to announce	1384	Setting this variable to 1 will cause AnyEvent::DNS to announce
1144	EDNS0 in its DNS requests.	1385	EDNS0 in its DNS requests.
1145		1386
1146	"PERL_ANYEVENT_MAX_FORKS"	1387	"PERL_ANYEVENT_MAX_FORKS"
…		…
1150	"PERL_ANYEVENT_MAX_OUTSTANDING_DNS"	1391	"PERL_ANYEVENT_MAX_OUTSTANDING_DNS"
1151	The default value for the "max_outstanding" parameter for the	1392	The default value for the "max_outstanding" parameter for the
1152	default DNS resolver - this is the maximum number of parallel DNS	1393	default DNS resolver - this is the maximum number of parallel DNS
1153	requests that are sent to the DNS server.	1394	requests that are sent to the DNS server.
1154		1395
		1396	"PERL_ANYEVENT_MAX_SIGNAL_LATENCY"
		1397	Perl has inherently racy signal handling (you can basically choose
		1398	between losing signals and memory corruption) - pure perl event
		1399	loops (including "AnyEvent::Loop", when "Async::Interrupt" isn't
		1400	available) therefore have to poll regularly to avoid losing signals.
		1401
		1402	Some event loops are racy, but don't poll regularly, and some event
		1403	loops are written in C but are still racy. For those event loops,
		1404	AnyEvent installs a timer that regularly wakes up the event loop.
		1405
		1406	By default, the interval for this timer is 10 seconds, but you can
		1407	override this delay with this environment variable (or by setting
		1408	the $AnyEvent::MAX_SIGNAL_LATENCY variable before creating signal
		1409	watchers).
		1410
		1411	Lower values increase CPU (and energy) usage, higher values can
		1412	introduce long delays when reaping children or waiting for signals.
		1413
		1414	The AnyEvent::Async module, if available, will be used to avoid this
		1415	polling (with most event loops).
		1416
1155	"PERL_ANYEVENT_RESOLV_CONF"	1417	"PERL_ANYEVENT_RESOLV_CONF"
1156	The file to use instead of /etc/resolv.conf (or OS-specific	1418	The absolute path to a resolv.conf-style file to use instead of
1157	configuration) in the default resolver. When set to the empty	1419	/etc/resolv.conf (or the OS-specific configuration) in the default
1158	string, no default config will be used.	1420	resolver, or the empty string to select the default configuration.
1159		1421
1160	"PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH".	1422	"PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH".
1161	When neither "ca_file" nor "ca_path" was specified during	1423	When neither "ca_file" nor "ca_path" was specified during
1162	AnyEvent::TLS context creation, and either of these environment	1424	AnyEvent::TLS context creation, and either of these environment
1163	variables exist, they will be used to specify CA certificate	1425	variables are nonempty, they will be used to specify CA certificate
1164	locations instead of a system-dependent default.	1426	locations instead of a system-dependent default.
1165		1427
1166	"PERL_ANYEVENT_AVOID_GUARD" and "PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT"	1428	"PERL_ANYEVENT_AVOID_GUARD" and "PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT"
1167	When these are set to 1, then the respective modules are not loaded.	1429	When these are set to 1, then the respective modules are not loaded.
1168	Mostly good for testing AnyEvent itself.	1430	Mostly good for testing AnyEvent itself.
…		…
1312		1574
1313	The actual code goes further and collects all errors ("die"s,	1575	The actual code goes further and collects all errors ("die"s,
1314	exceptions) that occurred during request processing. The "result" method	1576	exceptions) that occurred during request processing. The "result" method
1315	detects whether an exception as thrown (it is stored inside the $txn	1577	detects whether an exception as thrown (it is stored inside the $txn
1316	object) and just throws the exception, which means connection errors and	1578	object) and just throws the exception, which means connection errors and
1317	other problems get reported tot he code that tries to use the result,	1579	other problems get reported to the code that tries to use the result,
1318	not in a random callback.	1580	not in a random callback.
1319		1581
1320	All of this enables the following usage styles:	1582	All of this enables the following usage styles:
1321		1583
1322	1. Blocking:	1584	1. Blocking:
…		…
1488	when used without AnyEvent), but most event loops have acceptable	1750	when used without AnyEvent), but most event loops have acceptable
1489	performance with or without AnyEvent.	1751	performance with or without AnyEvent.
1490		1752
1491	* The overhead AnyEvent adds is usually much smaller than the overhead	1753	* The overhead AnyEvent adds is usually much smaller than the overhead
1492	of the actual event loop, only with extremely fast event loops such	1754	of the actual event loop, only with extremely fast event loops such
1493	as EV adds AnyEvent significant overhead.	1755	as EV does AnyEvent add significant overhead.
1494		1756
1495	* You should avoid POE like the plague if you want performance or	1757	* You should avoid POE like the plague if you want performance or
1496	reasonable memory usage.	1758	reasonable memory usage.
1497		1759
1498	BENCHMARKING THE LARGE SERVER CASE	1760	BENCHMARKING THE LARGE SERVER CASE
…		…
1696		1958
1697	Feel free to install your own handler, or reset it to defaults.	1959	Feel free to install your own handler, or reset it to defaults.
1698		1960
1699	RECOMMENDED/OPTIONAL MODULES	1961	RECOMMENDED/OPTIONAL MODULES
1700	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	1962	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
1701	it's built-in modules) are required to use it.	1963	its built-in modules) are required to use it.
1702		1964
1703	That does not mean that AnyEvent won't take advantage of some additional	1965	That does not mean that AnyEvent won't take advantage of some additional
1704	modules if they are installed.	1966	modules if they are installed.
1705		1967
1706	This section epxlains which additional modules will be used, and how	1968	This section explains which additional modules will be used, and how
1707	they affect AnyEvent's operetion.	1969	they affect AnyEvent's operation.
1708		1970
1709	Async::Interrupt	1971	Async::Interrupt
1710	This slightly arcane module is used to implement fast signal	1972	This slightly arcane module is used to implement fast signal
1711	handling: To my knowledge, there is no way to do completely	1973	handling: To my knowledge, there is no way to do completely
1712	race-free and quick signal handling in pure perl. To ensure that	1974	race-free and quick signal handling in pure perl. To ensure that
…		…
1715	10 seconds, look for $AnyEvent::MAX_SIGNAL_LATENCY).	1977	10 seconds, look for $AnyEvent::MAX_SIGNAL_LATENCY).
1716		1978
1717	If this module is available, then it will be used to implement	1979	If this module is available, then it will be used to implement
1718	signal catching, which means that signals will not be delayed, and	1980	signal catching, which means that signals will not be delayed, and
1719	the event loop will not be interrupted regularly, which is more	1981	the event loop will not be interrupted regularly, which is more
1720	efficient (And good for battery life on laptops).	1982	efficient (and good for battery life on laptops).
1721		1983
1722	This affects not just the pure-perl event loop, but also other event	1984	This affects not just the pure-perl event loop, but also other event
1723	loops that have no signal handling on their own (e.g. Glib, Tk, Qt).	1985	loops that have no signal handling on their own (e.g. Glib, Tk, Qt).
1724		1986
1725	Some event loops (POE, Event, Event::Lib) offer signal watchers	1987	Some event loops (POE, Event, Event::Lib) offer signal watchers
…		…
1735	clock is available, can take avdantage of advanced kernel interfaces	1997	clock is available, can take avdantage of advanced kernel interfaces
1736	such as "epoll" and "kqueue", and is the fastest backend by far.	1998	such as "epoll" and "kqueue", and is the fastest backend by far.
1737	You can even embed Glib/Gtk2 in it (or vice versa, see EV::Glib and	1999	You can even embed Glib/Gtk2 in it (or vice versa, see EV::Glib and
1738	Glib::EV).	2000	Glib::EV).
1739		2001
		2002	If you only use backends that rely on another event loop (e.g.
		2003	"Tk"), then this module will do nothing for you.
		2004
1740	Guard	2005	Guard
1741	The guard module, when used, will be used to implement	2006	The guard module, when used, will be used to implement
1742	"AnyEvent::Util::guard". This speeds up guards considerably (and	2007	"AnyEvent::Util::guard". This speeds up guards considerably (and
1743	uses a lot less memory), but otherwise doesn't affect guard	2008	uses a lot less memory), but otherwise doesn't affect guard
1744	operation much. It is purely used for performance.	2009	operation much. It is purely used for performance.
1745		2010
1746	JSON and JSON::XS	2011	JSON and JSON::XS
1747	One of these modules is required when you want to read or write JSON	2012	One of these modules is required when you want to read or write JSON
1748	data via AnyEvent::Handle. It is also written in pure-perl, but can	2013	data via AnyEvent::Handle. JSON is also written in pure-perl, but
1749	take advantage of the ultra-high-speed JSON::XS module when it is	2014	can take advantage of the ultra-high-speed JSON::XS module when it
1750	installed.	2015	is installed.
1751
1752	In fact, AnyEvent::Handle will use JSON::XS by default if it is
1753	installed.
1754		2016
1755	Net::SSLeay	2017	Net::SSLeay
1756	Implementing TLS/SSL in Perl is certainly interesting, but not very	2018	Implementing TLS/SSL in Perl is certainly interesting, but not very
1757	worthwhile: If this module is installed, then AnyEvent::Handle (with	2019	worthwhile: If this module is installed, then AnyEvent::Handle (with
1758	the help of AnyEvent::TLS), gains the ability to do TLS/SSL.	2020	the help of AnyEvent::TLS), gains the ability to do TLS/SSL.
1759		2021
1760	Time::HiRes	2022	Time::HiRes
1761	This module is part of perl since release 5.008. It will be used	2023	This module is part of perl since release 5.008. It will be used
1762	when the chosen event library does not come with a timing source on	2024	when the chosen event library does not come with a timing source of
1763	it's own. The pure-perl event loop (AnyEvent::Impl::Perl) will	2025	its own. The pure-perl event loop (AnyEvent::Loop) will additionally
1764	additionally use it to try to use a monotonic clock for timing	2026	load it to try to use a monotonic clock for timing stability.
1765	stability.	2027
		2028	AnyEvent::AIO (and IO::AIO)
		2029	The default implementation of AnyEvent::IO is to do I/O
		2030	synchronously, stopping programs while they access the disk, which
		2031	is fine for a lot of programs.
		2032
		2033	Installing AnyEvent::AIO (and its IO::AIO dependency) makes it
		2034	switch to a true asynchronous implementation, so event processing
		2035	can continue even while waiting for disk I/O.
1766		2036
1767	FORK	2037	FORK
1768	Most event libraries are not fork-safe. The ones who are usually are	2038	Most event libraries are not fork-safe. The ones who are usually are
1769	because they rely on inefficient but fork-safe "select" or "poll" calls.	2039	because they rely on inefficient but fork-safe "select" or "poll" calls
1770	Only EV is fully fork-aware.	2040	- higher performance APIs such as BSD's kqueue or the dreaded Linux
		2041	epoll are usually badly thought-out hacks that are incompatible with
		2042	fork in one way or another. Only EV is fully fork-aware and ensures that
		2043	you continue event-processing in both parent and child (or both, if you
		2044	know what you are doing).
		2045
		2046	This means that, in general, you cannot fork and do event processing in
		2047	the child if the event library was initialised before the fork (which
		2048	usually happens when the first AnyEvent watcher is created, or the
		2049	library is loaded).
1771		2050
1772	If you have to fork, you must either do so before creating your first	2051	If you have to fork, you must either do so before creating your first
1773	watcher OR you must not use AnyEvent at all in the child OR you must do	2052	watcher OR you must not use AnyEvent at all in the child OR you must do
1774	something completely out of the scope of AnyEvent.	2053	something completely out of the scope of AnyEvent (see below).
		2054
		2055	The problem of doing event processing in the parent and the child is
		2056	much more complicated: even for backends that are fork-aware or
		2057	fork-safe, their behaviour is not usually what you want: fork clones all
		2058	watchers, that means all timers, I/O watchers etc. are active in both
		2059	parent and child, which is almost never what you want. Using "exec" to
		2060	start worker children from some kind of manage prrocess is usually
		2061	preferred, because it is much easier and cleaner, at the expense of
		2062	having to have another binary.
		2063
		2064	In addition to logical problems with fork, there are also implementation
		2065	problems. For example, on POSIX systems, you cannot fork at all in Perl
		2066	code if a thread (I am talking of pthreads here) was ever created in the
		2067	process, and this is just the tip of the iceberg. In general, using fork
		2068	from Perl is difficult, and attempting to use fork without an exec to
		2069	implement some kind of parallel processing is almost certainly doomed.
		2070
		2071	To safely fork and exec, you should use a module such as Proc::FastSpawn
		2072	that let's you safely fork and exec new processes.
		2073
		2074	If you want to do multiprocessing using processes, you can look at the
		2075	AnyEvent::Fork module (and some related modules such as
		2076	AnyEvent::Fork::RPC, AnyEvent::Fork::Pool and AnyEvent::Fork::Remote).
		2077	This module allows you to safely create subprocesses without any
		2078	limitations - you can use X11 toolkits or AnyEvent in the children
		2079	created by AnyEvent::Fork safely and without any special precautions.
1775		2080
1776	SECURITY CONSIDERATIONS	2081	SECURITY CONSIDERATIONS
1777	AnyEvent can be forced to load any event model via	2082	AnyEvent can be forced to load any event model via
1778	$ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used	2083	$ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used
1779	to execute arbitrary code or directly gain access, it can easily be used	2084	to execute arbitrary code or directly gain access, it can easily be used
…		…
1803	5.10 and check wether the leaks still show up. (Perl 5.10.0 has other	2108	5.10 and check wether the leaks still show up. (Perl 5.10.0 has other
1804	annoying memleaks, such as leaking on "map" and "grep" but it is usually	2109	annoying memleaks, such as leaking on "map" and "grep" but it is usually
1805	not as pronounced).	2110	not as pronounced).
1806		2111
1807	SEE ALSO	2112	SEE ALSO
1808	Utility functions: AnyEvent::Util.	2113	Tutorial/Introduction: AnyEvent::Intro.
1809		2114
1810	Event modules: EV, EV::Glib, Glib::EV, Event, Glib::Event, Glib, Tk,	2115	FAQ: AnyEvent::FAQ.
1811	Event::Lib, Qt, POE.	2116
		2117	Utility functions: AnyEvent::Util (misc. grab-bag), AnyEvent::Log
		2118	(simply logging).
		2119
		2120	Development/Debugging: AnyEvent::Strict (stricter checking),
		2121	AnyEvent::Debug (interactive shell, watcher tracing).
		2122
		2123	Supported event modules: AnyEvent::Loop, EV, EV::Glib, Glib::EV, Event,
		2124	Glib::Event, Glib, Tk, Event::Lib, Qt, POE, FLTK.
1812		2125
1813	Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event,	2126	Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event,
1814	AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl,	2127	AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl,
1815	AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE,	2128	AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE,
1816	AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi.	2129	AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi, AnyEvent::Impl::FLTK.
1817		2130
1818	Non-blocking file handles, sockets, TCP clients and servers:	2131	Non-blocking handles, pipes, stream sockets, TCP clients and servers:
1819	AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS.	2132	AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS.
1820		2133
		2134	Asynchronous File I/O: AnyEvent::IO.
		2135
1821	Asynchronous DNS: AnyEvent::DNS.	2136	Asynchronous DNS: AnyEvent::DNS.
1822		2137
1823	Coroutine support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event,	2138	Thread support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event.
1824		2139
1825	Nontrivial usage examples: AnyEvent::GPSD, AnyEvent::XMPP,	2140	Nontrivial usage examples: AnyEvent::GPSD, AnyEvent::IRC,
1826	AnyEvent::HTTP.	2141	AnyEvent::HTTP.
1827		2142
1828	AUTHOR	2143	AUTHOR
1829	Marc Lehmann <schmorp@schmorp.de>	2144	Marc Lehmann <schmorp@schmorp.de>
1830	http://home.schmorp.de/	2145	http://anyevent.schmorp.de
1831		2146

Diff Legend

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

Comparing AnyEvent/README (file contents): Revision 1.55 by root, Mon Sep 14 05:05:09 2009 UTC vs. Revision 1.72 by root, Tue Dec 17 16:43:15 2013 UTC

Diff Legend

Comparing AnyEvent/README (file contents):
Revision 1.55 by root, Mon Sep 14 05:05:09 2009 UTC vs.
Revision 1.72 by root, Tue Dec 17 16:43:15 2013 UTC