[ViewVC] Diff of: cvs/AnyEvent/README

Comparing AnyEvent/README (file contents):
Revision 1.63 by root, Wed Oct 13 19:49:46 2010 UTC vs.
Revision 1.79 by root, Tue Feb 26 02:08:34 2019 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, UV, Perl, Event::Lib, Irssi, rxvt-unicode,
5	Qt and POE are various supported event loops/environments.	5	IO::Async, Qt, FLTK and POE are various supported event
		6	loops/environments.
6		7
7	SYNOPSIS	8	SYNOPSIS
8	use AnyEvent;	9	use AnyEvent;
9		10
10	# if you prefer function calls, look at the AE manpage for	11	# if you prefer function calls, look at the AE manpage for
80	that isn't them. What's worse, all the potential users of your module	81	that isn't them. What's worse, all the potential users of your module
81	are also forced to use the same event loop you use.	82	are also forced to use the same event loop you use.
82		83
83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	84	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	85	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
85	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if your	86	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
86	module uses one of those, every user of your module has to use it, too.	87	uses one of those, every user of your module has to use it, too. But if
87	But if your module uses AnyEvent, it works transparently with all event	88	your module uses AnyEvent, it works transparently with all event models
88	models it supports (including stuff like IO::Async, as long as those use	89	it supports (including stuff like IO::Async, as long as those use one of
89	one of the supported event loops. It is easy to add new event loops to	90	the supported event loops. It is easy to add new event loops to
90	AnyEvent, too, so it is future-proof).	91	AnyEvent, too, so it is future-proof).
91		92
92	In addition to being free of having to use *the one and only true event	93	In addition to being free of having to use *the one and only true event
93	model*, AnyEvent also is free of bloat and policy: with POE or similar	94	model*, AnyEvent also is free of bloat and policy: with POE or similar
94	modules, you get an enormous amount of code and strict rules you have to	95	modules, you get an enormous amount of code and strict rules you have to
…		…
115	The interface itself is vaguely similar, but not identical to the Event	116	The interface itself is vaguely similar, but not identical to the Event
116	module.	117	module.
117		118
118	During the first call of any watcher-creation method, the module tries	119	During the first call of any watcher-creation method, the module tries
119	to detect the currently loaded event loop by probing whether one of the	120	to detect the currently loaded event loop by probing whether one of the
120	following modules is already loaded: EV, AnyEvent::Impl::Perl, Event,	121	following modules is already loaded: EV, AnyEvent::Loop, Event, Glib,
121	Glib, Tk, Event::Lib, Qt, POE. The first one found is used. If none are	122	Tk, Event::Lib, Qt, POE. The first one found is used. If none are
122	detected, the module tries to load the first four modules in the order	123	detected, the module tries to load the first four modules in the order
123	given; but note that if EV is not available, the pure-perl	124	given; but note that if EV is not available, the pure-perl
124	AnyEvent::Impl::Perl should always work, so the other two are not	125	AnyEvent::Loop should always work, so the other two are not normally
125	normally tried.	126	tried.
126		127
127	Because AnyEvent first checks for modules that are already loaded,	128	Because AnyEvent first checks for modules that are already loaded,
128	loading an event model explicitly before first using AnyEvent will	129	loading an event model explicitly before first using AnyEvent will
129	likely make that model the default. For example:	130	likely make that model the default. For example:
130		131
…		…
136	The likely means that, if any module loads another event model and	137	The likely means that, if any module loads another event model and
137	starts using it, all bets are off - this case should be very rare	138	starts using it, all bets are off - this case should be very rare
138	though, as very few modules hardcode event loops without announcing this	139	though, as very few modules hardcode event loops without announcing this
139	very loudly.	140	very loudly.
140		141
141	The pure-perl implementation of AnyEvent is called	142	The pure-perl implementation of AnyEvent is called "AnyEvent::Loop".
142	"AnyEvent::Impl::Perl". Like other event modules you can load it	143	Like other event modules you can load it explicitly and enjoy the high
143	explicitly and enjoy the high availability of that event loop :)	144	availability of that event loop :)
144		145
145	WATCHERS	146	WATCHERS
146	AnyEvent has the central concept of a watcher, which is an object that	147	AnyEvent has the central concept of a watcher, which is an object that
147	stores relevant data for each kind of event you are waiting for, such as	148	stores relevant data for each kind of event you are waiting for, such as
148	the callback to call, the file handle to watch, etc.	149	the callback to call, the file handle to watch, etc.
…		…
262		263
263	Example 2: fire an event after 0.5 seconds, then roughly every second.	264	Example 2: fire an event after 0.5 seconds, then roughly every second.
264		265
265	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {	266	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
266	warn "timeout\n";	267	warn "timeout\n";
267	};	268	});
268		269
269	TIMING ISSUES	270	TIMING ISSUES
270	There are two ways to handle timers: based on real time (relative, "fire	271	There are two ways to handle timers: based on real time (relative, "fire
271	in 10 seconds") and based on wallclock time (absolute, "fire at 12	272	in 10 seconds") and based on wallclock time (absolute, "fire at 12
272	o'clock").	273	o'clock").
…		…
347	can get whatever behaviour you want with any event loop, by taking	348	can get whatever behaviour you want with any event loop, by taking
348	the difference between "AnyEvent->time" and "AnyEvent->now" into	349	the difference between "AnyEvent->time" and "AnyEvent->now" into
349	account.	350	account.
350		351
351	AnyEvent->now_update	352	AnyEvent->now_update
352	Some event loops (such as EV or AnyEvent::Impl::Perl) cache the	353	Some event loops (such as EV or AnyEvent::Loop) cache the current
353	current time for each loop iteration (see the discussion of	354	time for each loop iteration (see the discussion of AnyEvent->now,
354	AnyEvent->now, above).	355	above).
355		356
356	When a callback runs for a long time (or when the process sleeps),	357	When a callback runs for a long time (or when the process sleeps),
357	then this "current" time will differ substantially from the real	358	then this "current" time will differ substantially from the real
358	time, which might affect timers and time-outs.	359	time, which might affect timers and time-outs.
359		360
…		…
403	will not restart syscalls (that includes Async::Interrupt and AnyEvent's	404	will not restart syscalls (that includes Async::Interrupt and AnyEvent's
404	pure perl implementation).	405	pure perl implementation).
405		406
406	Safe/Unsafe Signals	407	Safe/Unsafe Signals
407	Perl signals can be either "safe" (synchronous to opcode handling) or	408	Perl signals can be either "safe" (synchronous to opcode handling) or
408	"unsafe" (asynchronous) - the former might get delayed indefinitely, the	409	"unsafe" (asynchronous) - the former might delay signal delivery
409	latter might corrupt your memory.	410	indefinitely, the latter might corrupt your memory.
410		411
411	AnyEvent signal handlers are, in addition, synchronous to the event	412	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	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	only be called as part of the normal event handling (just like timer,
414	I/O etc. callbacks, too).	415	I/O etc. callbacks, too).
…		…
416	Signal Races, Delays and Workarounds	417	Signal Races, Delays and Workarounds
417	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	418	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
418	callbacks to signals in a generic way, which is a pity, as you cannot do	419	callbacks to signals in a generic way, which is a pity, as you cannot do
419	race-free signal handling in perl, requiring C libraries for this.	420	race-free signal handling in perl, requiring C libraries for this.
420	AnyEvent will try to do its best, which means in some cases, signals	421	AnyEvent will try to do its best, which means in some cases, signals
421	will be delayed. The maximum time a signal might be delayed is specified	422	will be delayed. The maximum time a signal might be delayed is 10
422	in $AnyEvent::MAX_SIGNAL_LATENCY (default: 10 seconds). This variable	423	seconds by default, but can be overriden via
423	can be changed only before the first signal watcher is created, and	424	$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} or $AnyEvent::MAX_SIGNAL_LATENCY
424	should be left alone otherwise. This variable determines how often	425	- see the "ENVIRONMENT VARIABLES" section for details.
425	AnyEvent polls for signals (in case a wake-up was missed). Higher values
426	will cause fewer spurious wake-ups, which is better for power and CPU
427	saving.
428		426
429	All these problems can be avoided by installing the optional	427	All these problems can be avoided by installing the optional
430	Async::Interrupt module, which works with most event loops. It will not	428	Async::Interrupt module, which works with most event loops. It will not
431	work with inherently broken event loops such as Event or Event::Lib (and	429	work with inherently broken event loops such as Event or Event::Lib (and
432	not with POE currently, as POE does its own workaround with one-second
433	latency). For those, you just have to suffer the delays.	430	not with POE currently). For those, you just have to suffer the delays.
434		431
435	CHILD PROCESS WATCHERS	432	CHILD PROCESS WATCHERS
436	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	433	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
437		434
438	You can also watch for a child process exit and catch its exit status.	435	You can also watch for a child process exit and catch its exit status.
…		…
466	This means you cannot create a child watcher as the very first thing in	463	This means you cannot create a child watcher as the very first thing in
467	an AnyEvent program, you have to create at least one watcher before	464	an AnyEvent program, you have to create at least one watcher before
468	you "fork" the child (alternatively, you can call "AnyEvent::detect").	465	you "fork" the child (alternatively, you can call "AnyEvent::detect").
469		466
470	As most event loops do not support waiting for child events, they will	467	As most event loops do not support waiting for child events, they will
471	be emulated by AnyEvent in most cases, in which the latency and race	468	be emulated by AnyEvent in most cases, in which case the latency and
472	problems mentioned in the description of signal watchers apply.	469	race problems mentioned in the description of signal watchers apply.
473		470
474	Example: fork a process and wait for it	471	Example: fork a process and wait for it
475		472
476	my $done = AnyEvent->condvar;	473	my $done = AnyEvent->condvar;
477		474
		475	# this forks and immediately calls exit in the child. this
		476	# normally has all sorts of bad consequences for your parent,
		477	# so take this as an example only. always fork and exec,
		478	# or call POSIX::_exit, in real code.
478	my $pid = fork or exit 5;	479	my $pid = fork or exit 5;
479		480
480	my $w = AnyEvent->child (	481	my $w = AnyEvent->child (
481	pid => $pid,	482	pid => $pid,
482	cb => sub {	483	cb => sub {
…		…
722	This works because for every event source (EOF on file handle),	723	This works because for every event source (EOF on file handle),
723	there is one call to "begin", so the condvar waits for all calls to	724	there is one call to "begin", so the condvar waits for all calls to
724	"end" before sending.	725	"end" before sending.
725		726
726	The ping example mentioned above is slightly more complicated, as	727	The ping example mentioned above is slightly more complicated, as
727	the there are results to be passwd back, and the number of tasks	728	the there are results to be passed back, and the number of tasks
728	that are begun can potentially be zero:	729	that are begun can potentially be zero:
729		730
730	my $cv = AnyEvent->condvar;	731	my $cv = AnyEvent->condvar;
731		732
732	my %result;	733	my %result;
…		…
740	};	741	};
741	}	742	}
742		743
743	$cv->end;	744	$cv->end;
744		745
		746	...
		747
		748	my $results = $cv->recv;
		749
745	This code fragment supposedly pings a number of hosts and calls	750	This code fragment supposedly pings a number of hosts and calls
746	"send" after results for all then have have been gathered - in any	751	"send" after results for all then have have been gathered - in any
747	order. To achieve this, the code issues a call to "begin" when it	752	order. To achieve this, the code issues a call to "begin" when it
748	starts each ping request and calls "end" when it has received some	753	starts each ping request and calls "end" when it has received some
749	result for it. Since "begin" and "end" only maintain a counter, the	754	result for it. Since "begin" and "end" only maintain a counter, the
…		…
778	In list context, all parameters passed to "send" will be returned,	783	In list context, all parameters passed to "send" will be returned,
779	in scalar context only the first one will be returned.	784	in scalar context only the first one will be returned.
780		785
781	Note that doing a blocking wait in a callback is not supported by	786	Note that doing a blocking wait in a callback is not supported by
782	any event loop, that is, recursive invocation of a blocking "->recv"	787	any event loop, that is, recursive invocation of a blocking "->recv"
783	is not allowed, and the "recv" call will "croak" if such a condition	788	is not allowed and the "recv" call will "croak" if such a condition
784	is detected. This condition can be slightly loosened by using	789	is detected. This requirement can be dropped by relying on
785	Coro::AnyEvent, which allows you to do a blocking "->recv" from any	790	Coro::AnyEvent , which allows you to do a blocking "->recv" from any
786	thread that doesn't run the event loop itself.	791	thread that doesn't run the event loop itself. Coro::AnyEvent is
		792	loaded automatically when Coro is used with AnyEvent, so code does
		793	not need to do anything special to take advantage of that: any code
		794	that would normally block your program because it calls "recv", be
		795	executed in an "async" thread instead without blocking other
		796	threads.
787		797
788	Not all event models support a blocking wait - some die in that case	798	Not all event models support a blocking wait - some die in that case
789	(programs might want to do that to stay interactive), so *if you are	799	(programs might want to do that to stay interactive), so *if you are
790	using this from a module, never require a blocking wait*. Instead,	800	using this from a module, never require a blocking wait*. Instead,
791	let the caller decide whether the call will block or not (for	801	let the caller decide whether the call will block or not (for
…		…
802	$bool = $cv->ready	812	$bool = $cv->ready
803	Returns true when the condition is "true", i.e. whether "send" or	813	Returns true when the condition is "true", i.e. whether "send" or
804	"croak" have been called.	814	"croak" have been called.
805		815
806	$cb = $cv->cb ($cb->($cv))	816	$cb = $cv->cb ($cb->($cv))
807	This is a mutator function that returns the callback set and	817	This is a mutator function that returns the callback set (or "undef"
808	optionally replaces it before doing so.	818	if not) and optionally replaces it before doing so.
809		819
810	The callback will be called when the condition becomes "true", i.e.	820	The callback will be called when the condition becomes "true", i.e.
811	when "send" or "croak" are called, with the only argument being the	821	when "send" or "croak" are called, with the only argument being the
812	condition variable itself. If the condition is already true, the	822	condition variable itself. If the condition is already true, the
813	callback is called immediately when it is set. Calling "recv" inside	823	callback is called immediately when it is set. Calling "recv" inside
814	the callback or at any later time is guaranteed not to block.	824	the callback or at any later time is guaranteed not to block.
815		825
		826	Additionally, when the callback is invoked, it is also removed from
		827	the condvar (reset to "undef"), so the condvar does not keep a
		828	reference to the callback after invocation.
		829
816	SUPPORTED EVENT LOOPS/BACKENDS	830	SUPPORTED EVENT LOOPS/BACKENDS
817	The available backend classes are (every class has its own manpage):	831	The following backend classes are part of the AnyEvent distribution
		832	(every class has its own manpage):
818		833
819	Backends that are autoprobed when no other event loop can be found.	834	Backends that are autoprobed when no other event loop can be found.
820	EV is the preferred backend when no other event loop seems to be in	835	EV is the preferred backend when no other event loop seems to be in
821	use. If EV is not installed, then AnyEvent will fall back to its own	836	use. If EV is not installed, then AnyEvent will fall back to its own
822	pure-perl implementation, which is available everywhere as it comes	837	pure-perl implementation, which is available everywhere as it comes
823	with AnyEvent itself.	838	with AnyEvent itself.
824		839
825	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	840	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
826	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	841	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
827		842
828	Backends that are transparently being picked up when they are used.	843	Backends that are transparently being picked up when they are used.
829	These will be used if they are already loaded when the first watcher	844	These will be used if they are already loaded when the first watcher
830	is created, in which case it is assumed that the application is	845	is created, in which case it is assumed that the application is
831	using them. This means that AnyEvent will automatically pick the	846	using them. This means that AnyEvent will automatically pick the
…		…
834	by the main program.	849	by the main program.
835		850
836	AnyEvent::Impl::Event based on Event, very stable, few glitches.	851	AnyEvent::Impl::Event based on Event, very stable, few glitches.
837	AnyEvent::Impl::Glib based on Glib, slow but very stable.	852	AnyEvent::Impl::Glib based on Glib, slow but very stable.
838	AnyEvent::Impl::Tk based on Tk, very broken.	853	AnyEvent::Impl::Tk based on Tk, very broken.
		854	AnyEvent::Impl::UV based on UV, innovated square wheels.
839	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	855	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
840	AnyEvent::Impl::POE based on POE, very slow, some limitations.	856	AnyEvent::Impl::POE based on POE, very slow, some limitations.
841	AnyEvent::Impl::Irssi used when running within irssi.	857	AnyEvent::Impl::Irssi used when running within irssi.
		858	AnyEvent::Impl::IOAsync based on IO::Async.
		859	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		860	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
842		861
843	Backends with special needs.	862	Backends with special needs.
844	Qt requires the Qt::Application to be instantiated first, but will	863	Qt requires the Qt::Application to be instantiated first, but will
845	otherwise be picked up automatically. As long as the main program	864	otherwise be picked up automatically. As long as the main program
846	instantiates the application before any AnyEvent watchers are	865	instantiates the application before any AnyEvent watchers are
847	created, everything should just work.	866	created, everything should just work.
848		867
849	AnyEvent::Impl::Qt based on Qt.	868	AnyEvent::Impl::Qt based on Qt.
850		869
851	Support for IO::Async can only be partial, as it is too broken and
852	architecturally limited to even support the AnyEvent API. It also is
853	the only event loop that needs the loop to be set explicitly, so it
854	can only be used by a main program knowing about AnyEvent. See
855	AnyEvent::Impl::IOAsync for the gory details.
856
857	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
858
859	Event loops that are indirectly supported via other backends.	870	Event loops that are indirectly supported via other backends.
860	Some event loops can be supported via other modules:	871	Some event loops can be supported via other modules:
861		872
862	There is no direct support for WxWidgets (Wx) or Prima.	873	There is no direct support for WxWidgets (Wx) or Prima.
863		874
…		…
870	POE backend, so it can be supported through POE.	881	POE backend, so it can be supported through POE.
871		882
872	AnyEvent knows about both Prima and Wx, however, and will try to	883	AnyEvent knows about both Prima and Wx, however, and will try to
873	load POE when detecting them, in the hope that POE will pick them	884	load POE when detecting them, in the hope that POE will pick them
874	up, in which case everything will be automatic.	885	up, in which case everything will be automatic.
		886
		887	Known event loops outside the AnyEvent distribution
		888	The following event loops or programs support AnyEvent by providing
		889	their own AnyEvent backend. They will be picked up automatically.
		890
		891	urxvt::anyevent available to rxvt-unicode extensions
875		892
876	GLOBAL VARIABLES AND FUNCTIONS	893	GLOBAL VARIABLES AND FUNCTIONS
877	These are not normally required to use AnyEvent, but can be useful to	894	These are not normally required to use AnyEvent, but can be useful to
878	write AnyEvent extension modules.	895	write AnyEvent extension modules.
879		896
…		…
892	if necessary. You should only call this function right before you	909	if necessary. You should only call this function right before you
893	would have created an AnyEvent watcher anyway, that is, as late as	910	would have created an AnyEvent watcher anyway, that is, as late as
894	possible at runtime, and not e.g. during initialisation of your	911	possible at runtime, and not e.g. during initialisation of your
895	module.	912	module.
896		913
		914	The effect of calling this function is as if a watcher had been
		915	created (specifically, actions that happen "when the first watcher
		916	is created" happen when calling detetc as well).
		917
897	If you need to do some initialisation before AnyEvent watchers are	918	If you need to do some initialisation before AnyEvent watchers are
898	created, use "post_detect".	919	created, use "post_detect".
899		920
900	$guard = AnyEvent::post_detect { BLOCK }	921	$guard = AnyEvent::post_detect { BLOCK }
901	Arranges for the code block to be executed as soon as the event	922	Arranges for the code block to be executed as soon as the event
902	model is autodetected (or immediately if that has already happened).	923	model is autodetected (or immediately if that has already happened).
903		924
904	The block will be executed after the actual backend has been	925	The block will be executed after the actual backend has been
905	detected ($AnyEvent::MODEL is set), but before any watchers have	926	detected ($AnyEvent::MODEL is set), so it is possible to do some
906	been created, so it is possible to e.g. patch @AnyEvent::ISA or do	927	initialisation only when AnyEvent is actually initialised - see the
907	other initialisations - see the sources of AnyEvent::Strict or
908	AnyEvent::AIO to see how this is used.	928	sources of AnyEvent::AIO to see how this is used.
909		929
910	The most common usage is to create some global watchers, without	930	The most common usage is to create some global watchers, without
911	forcing event module detection too early, for example, AnyEvent::AIO	931	forcing event module detection too early. For example, AnyEvent::AIO
912	creates and installs the global IO::AIO watcher in a "post_detect"	932	creates and installs the global IO::AIO watcher in a "post_detect"
913	block to avoid autodetecting the event module at load time.	933	block to avoid autodetecting the event module at load time.
914		934
915	If called in scalar or list context, then it creates and returns an	935	If called in scalar or list context, then it creates and returns an
916	object that automatically removes the callback again when it is	936	object that automatically removes the callback again when it is
…		…
932	# able to just C<undef $WATCHER> if the watcher causes them grief.	952	# able to just C<undef $WATCHER> if the watcher causes them grief.
933		953
934	$WATCHER \|\|= $guard;	954	$WATCHER \|\|= $guard;
935		955
936	@AnyEvent::post_detect	956	@AnyEvent::post_detect
937	If there are any code references in this array (you can "push" to it	957	This is a lower level interface then "AnyEvent::post_detect" (the
938	before or after loading AnyEvent), then they will be called directly	958	function). This variable is mainly useful for modules that can do
		959	something useful when AnyEvent is used and thus want to know when it
		960	is initialised, but do not need to even load it by default. This
		961	array provides the means to hook into AnyEvent passively, without
		962	loading it.
		963
		964	Here is how it works: If there are any code references in this array
		965	(you can "push" to it before or after loading AnyEvent), then they
939	after the event loop has been chosen.	966	will be called directly after the event loop has been chosen.
940		967
941	You should check $AnyEvent::MODEL before adding to this array,	968	You should check $AnyEvent::MODEL before adding to this array,
942	though: if it is defined then the event loop has already been	969	though: if it is defined then the event loop has already been
943	detected, and the array will be ignored.	970	detected, and the array will be ignored.
944		971
945	Best use "AnyEvent::post_detect { BLOCK }" when your application	972	Best use "AnyEvent::post_detect { BLOCK }" when your application
946	allows it, as it takes care of these details.	973	allows it, as it takes care of these details.
947
948	This variable is mainly useful for modules that can do something
949	useful when AnyEvent is used and thus want to know when it is
950	initialised, but do not need to even load it by default. This array
951	provides the means to hook into AnyEvent passively, without loading
952	it.
953		974
954	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used	975	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
955	together, you could put this into Coro (this is the actual code used	976	together, you could put this into Coro (this is the actual code used
956	by Coro to accomplish this):	977	by Coro to accomplish this):
957		978
…		…
962	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	983	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
963	# as soon as it is	984	# as soon as it is
964	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	985	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
965	}	986	}
966		987
		988	AnyEvent::postpone { BLOCK }
		989	Arranges for the block to be executed as soon as possible, but not
		990	before the call itself returns. In practise, the block will be
		991	executed just before the event loop polls for new events, or shortly
		992	afterwards.
		993
		994	This function never returns anything (to make the "return postpone {
		995	... }" idiom more useful.
		996
		997	To understand the usefulness of this function, consider a function
		998	that asynchronously does something for you and returns some
		999	transaction object or guard to let you cancel the operation. For
		1000	example, "AnyEvent::Socket::tcp_connect":
		1001
		1002	# start a connection attempt unless one is active
		1003	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1004	delete $self->{connect_guard};
		1005	...
		1006	};
		1007
		1008	Imagine that this function could instantly call the callback, for
		1009	example, because it detects an obvious error such as a negative port
		1010	number. Invoking the callback before the function returns causes
		1011	problems however: the callback will be called and will try to delete
		1012	the guard object. But since the function hasn't returned yet, there
		1013	is nothing to delete. When the function eventually returns it will
		1014	assign the guard object to "$self->{connect_guard}", where it will
		1015	likely never be deleted, so the program thinks it is still trying to
		1016	connect.
		1017
		1018	This is where "AnyEvent::postpone" should be used. Instead of
		1019	calling the callback directly on error:
		1020
		1021	$cb->(undef), return # signal error to callback, BAD!
		1022	if $some_error_condition;
		1023
		1024	It should use "postpone":
		1025
		1026	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1027	if $some_error_condition;
		1028
		1029	AnyEvent::log $level, $msg[, @args]
		1030	Log the given $msg at the given $level.
		1031
		1032	If AnyEvent::Log is not loaded then this function makes a simple
		1033	test to see whether the message will be logged. If the test succeeds
		1034	it will load AnyEvent::Log and call "AnyEvent::Log::log" -
		1035	consequently, look at the AnyEvent::Log documentation for details.
		1036
		1037	If the test fails it will simply return. Right now this happens when
		1038	a numerical loglevel is used and it is larger than the level
		1039	specified via $ENV{PERL_ANYEVENT_VERBOSE}.
		1040
		1041	If you want to sprinkle loads of logging calls around your code,
		1042	consider creating a logger callback with the "AnyEvent::Log::logger"
		1043	function, which can reduce typing, codesize and can reduce the
		1044	logging overhead enourmously.
		1045
		1046	AnyEvent::fh_block $filehandle
		1047	AnyEvent::fh_unblock $filehandle
		1048	Sets blocking or non-blocking behaviour for the given filehandle.
		1049
967	WHAT TO DO IN A MODULE	1050	WHAT TO DO IN A MODULE
968	As a module author, you should "use AnyEvent" and call AnyEvent methods	1051	As a module author, you should "use AnyEvent" and call AnyEvent methods
969	freely, but you should not load a specific event module or rely on it.	1052	freely, but you should not load a specific event module or rely on it.
970		1053
971	Be careful when you create watchers in the module body - AnyEvent will	1054	Be careful when you create watchers in the module body - AnyEvent will
…		…
1001	will decide on the event model to use as soon as it creates watchers,	1084	will decide on the event model to use as soon as it creates watchers,
1002	and it might choose the wrong one unless you load the correct one	1085	and it might choose the wrong one unless you load the correct one
1003	yourself.	1086	yourself.
1004		1087
1005	You can chose to use a pure-perl implementation by loading the	1088	You can chose to use a pure-perl implementation by loading the
1006	"AnyEvent::Impl::Perl" module, which gives you similar behaviour	1089	"AnyEvent::Loop" module, which gives you similar behaviour everywhere,
1007	everywhere, but letting AnyEvent chose the model is generally better.	1090	but letting AnyEvent chose the model is generally better.
1008		1091
1009	MAINLOOP EMULATION	1092	MAINLOOP EMULATION
1010	Sometimes (often for short test scripts, or even standalone programs who	1093	Sometimes (often for short test scripts, or even standalone programs who
1011	only want to use AnyEvent), you do not want to run a specific event	1094	only want to use AnyEvent), you do not want to run a specific event
1012	loop.	1095	loop.
…		…
1024		1107
1025	OTHER MODULES	1108	OTHER MODULES
1026	The following is a non-exhaustive list of additional modules that use	1109	The following is a non-exhaustive list of additional modules that use
1027	AnyEvent as a client and can therefore be mixed easily with other	1110	AnyEvent as a client and can therefore be mixed easily with other
1028	AnyEvent modules and other event loops in the same program. Some of the	1111	AnyEvent modules and other event loops in the same program. Some of the
1029	modules come as part of AnyEvent, the others are available via CPAN.	1112	modules come as part of AnyEvent, the others are available via CPAN (see
		1113	<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for a longer
		1114	non-exhaustive list), and the list is heavily biased towards modules of
		1115	the AnyEvent author himself :)
1030		1116
1031	AnyEvent::Util	1117	AnyEvent::Util (part of the AnyEvent distribution)
1032	Contains various utility functions that replace often-used blocking	1118	Contains various utility functions that replace often-used blocking
1033	functions such as "inet_aton" with event/callback-based versions.	1119	functions such as "inet_aton" with event/callback-based versions.
1034		1120
1035	AnyEvent::Socket	1121	AnyEvent::Socket (part of the AnyEvent distribution)
1036	Provides various utility functions for (internet protocol) sockets,	1122	Provides various utility functions for (internet protocol) sockets,
1037	addresses and name resolution. Also functions to create non-blocking	1123	addresses and name resolution. Also functions to create non-blocking
1038	tcp connections or tcp servers, with IPv6 and SRV record support and	1124	tcp connections or tcp servers, with IPv6 and SRV record support and
1039	more.	1125	more.
1040		1126
1041	AnyEvent::Handle	1127	AnyEvent::Handle (part of the AnyEvent distribution)
1042	Provide read and write buffers, manages watchers for reads and	1128	Provide read and write buffers, manages watchers for reads and
1043	writes, supports raw and formatted I/O, I/O queued and fully	1129	writes, supports raw and formatted I/O, I/O queued and fully
1044	transparent and non-blocking SSL/TLS (via AnyEvent::TLS).	1130	transparent and non-blocking SSL/TLS (via AnyEvent::TLS).
1045		1131
1046	AnyEvent::DNS	1132	AnyEvent::DNS (part of the AnyEvent distribution)
1047	Provides rich asynchronous DNS resolver capabilities.	1133	Provides rich asynchronous DNS resolver capabilities.
1048		1134
1049	AnyEvent::HTTP, AnyEvent::IRC, AnyEvent::XMPP, AnyEvent::GPSD,	1135	AnyEvent::HTTP, AnyEvent::IRC, AnyEvent::XMPP, AnyEvent::GPSD,
1050	AnyEvent::IGS, AnyEvent::FCP	1136	AnyEvent::IGS, AnyEvent::FCP
1051	Implement event-based interfaces to the protocols of the same name	1137	Implement event-based interfaces to the protocols of the same name
1052	(for the curious, IGS is the International Go Server and FCP is the	1138	(for the curious, IGS is the International Go Server and FCP is the
1053	Freenet Client Protocol).	1139	Freenet Client Protocol).
1054		1140
1055	AnyEvent::Handle::UDP	1141	AnyEvent::AIO (part of the AnyEvent distribution)
1056	Here be danger!
1057
1058	As Pauli would put it, "Not only is it not right, it's not even
1059	wrong!" - there are so many things wrong with AnyEvent::Handle::UDP,
1060	most notably its use of a stream-based API with a protocol that
1061	isn't streamable, that the only way to improve it is to delete it.
1062
1063	It features data corruption (but typically only under load) and
1064	general confusion. On top, the author is not only clueless about UDP
1065	but also fact-resistant - some gems of his understanding: "connect
1066	doesn't work with UDP", "UDP packets are not IP packets", "UDP only
1067	has datagrams, not packets", "I don't need to implement proper error
1068	checking as UDP doesn't support error checking" and so on - he
1069	doesn't even understand what's wrong with his module when it is
1070	explained to him.
1071
1072	AnyEvent::DBI
1073	Executes DBI requests asynchronously in a proxy process for you,
1074	notifying you in an event-based way when the operation is finished.
1075
1076	AnyEvent::AIO
1077	Truly asynchronous (as opposed to non-blocking) I/O, should be in	1142	Truly asynchronous (as opposed to non-blocking) I/O, should be in
1078	the toolbox of every event programmer. AnyEvent::AIO transparently	1143	the toolbox of every event programmer. AnyEvent::AIO transparently
1079	fuses IO::AIO and AnyEvent together, giving AnyEvent access to	1144	fuses IO::AIO and AnyEvent together, giving AnyEvent access to
1080	event-based file I/O, and much more.	1145	event-based file I/O, and much more.
1081		1146
		1147	AnyEvent::Fork, AnyEvent::Fork::RPC, AnyEvent::Fork::Pool,
		1148	AnyEvent::Fork::Remote
		1149	These let you safely fork new subprocesses, either locally or
		1150	remotely (e.g.v ia ssh), using some RPC protocol or not, without the
		1151	limitations normally imposed by fork (AnyEvent works fine for
		1152	example). Dynamically-resized worker pools are obviously included as
		1153	well.
		1154
		1155	And they are quite tiny and fast as well - "abusing" AnyEvent::Fork
		1156	just to exec external programs can easily beat using "fork" and
		1157	"exec" (or even "system") in most programs.
		1158
		1159	AnyEvent::Filesys::Notify
		1160	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1161	path changes (e.g. "watch this directory for new files", "watch this
		1162	file for changes"). The AnyEvent::Filesys::Notify module promises to
		1163	do just that in a portbale fashion, supporting inotify on GNU/Linux
		1164	and some weird, without doubt broken, stuff on OS X to monitor
		1165	files. It can fall back to blocking scans at regular intervals
		1166	transparently on other platforms, so it's about as portable as it
		1167	gets.
		1168
		1169	(I haven't used it myself, but it seems the biggest problem with it
		1170	is it quite bad performance).
		1171
1082	AnyEvent::HTTPD	1172	AnyEvent::DBI
1083	A simple embedded webserver.	1173	Executes DBI requests asynchronously in a proxy process for you,
		1174	notifying you in an event-based way when the operation is finished.
1084		1175
1085	AnyEvent::FastPing	1176	AnyEvent::FastPing
1086	The fastest ping in the west.	1177	The fastest ping in the west.
1087		1178
1088	Coro	1179	Coro
1089	Has special support for AnyEvent via Coro::AnyEvent.	1180	Has special support for AnyEvent via Coro::AnyEvent, which allows
		1181	you to simply invert the flow control - don't call us, we will call
		1182	you:
		1183
		1184	async {
		1185	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1186	print "5 seconds later!\n";
		1187
		1188	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1189	my $line = <STDIN>; # works for ttys
		1190
		1191	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1192	my ($body, $hdr) = Coro::rouse_wait;
		1193	};
1090		1194
1091	SIMPLIFIED AE API	1195	SIMPLIFIED AE API
1092	Starting with version 5.0, AnyEvent officially supports a second, much	1196	Starting with version 5.0, AnyEvent officially supports a second, much
1093	simpler, API that is designed to reduce the calling, typing and memory	1197	simpler, API that is designed to reduce the calling, typing and memory
1094	overhead by using function call syntax and a fixed number of parameters.	1198	overhead by using function call syntax and a fixed number of parameters.
…		…
1110	The pure perl event loop simply re-throws the exception (usually within	1214	The pure perl event loop simply re-throws the exception (usually within
1111	"condvar->recv"), the Event and EV modules call "$Event/EV::DIED->()",	1215	"condvar->recv"), the Event and EV modules call "$Event/EV::DIED->()",
1112	Glib uses "install_exception_handler" and so on.	1216	Glib uses "install_exception_handler" and so on.
1113		1217
1114	ENVIRONMENT VARIABLES	1218	ENVIRONMENT VARIABLES
1115	The following environment variables are used by this module or its	1219	AnyEvent supports a number of environment variables that tune the
1116	submodules.	1220	runtime behaviour. They are usually evaluated when AnyEvent is loaded,
		1221	initialised, or a submodule that uses them is loaded. Many of them also
		1222	cause AnyEvent to load additional modules - for example,
		1223	"PERL_ANYEVENT_DEBUG_WRAP" causes the AnyEvent::Debug module to be
		1224	loaded.
1117		1225
1118	Note that AnyEvent will remove all environment variables starting with	1226	All the environment variables documented here start with
1119	"PERL_ANYEVENT_" from %ENV when it is loaded while taint mode is	1227	"PERL_ANYEVENT_", which is what AnyEvent considers its own namespace.
1120	enabled.	1228	Other modules are encouraged (but by no means required) to use
		1229	"PERL_ANYEVENT_SUBMODULE" if they have registered the
		1230	AnyEvent::Submodule namespace on CPAN, for any submodule. For example,
		1231	AnyEvent::HTTP could be expected to use "PERL_ANYEVENT_HTTP_PROXY" (it
		1232	should not access env variables starting with "AE_", see below).
		1233
		1234	All variables can also be set via the "AE_" prefix, that is, instead of
		1235	setting "PERL_ANYEVENT_VERBOSE" you can also set "AE_VERBOSE". In case
		1236	there is a clash btween anyevent and another program that uses
		1237	"AE_something" you can set the corresponding "PERL_ANYEVENT_something"
		1238	variable to the empty string, as those variables take precedence.
		1239
		1240	When AnyEvent is first loaded, it copies all "AE_xxx" env variables to
		1241	their "PERL_ANYEVENT_xxx" counterpart unless that variable already
		1242	exists. If taint mode is on, then AnyEvent will remove all environment
		1243	variables starting with "PERL_ANYEVENT_" from %ENV (or replace them with
		1244	"undef" or the empty string, if the corresaponding "AE_" variable is
		1245	set).
		1246
		1247	The exact algorithm is currently:
		1248
		1249	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		1250	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		1251	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		1252
		1253	This ensures that child processes will not see the "AE_" variables.
		1254
		1255	The following environment variables are currently known to AnyEvent:
1121		1256
1122	"PERL_ANYEVENT_VERBOSE"	1257	"PERL_ANYEVENT_VERBOSE"
1123	By default, AnyEvent will be completely silent except in fatal	1258	By default, AnyEvent will log messages with loglevel 4 ("error") or
1124	conditions. You can set this environment variable to make AnyEvent	1259	higher (see AnyEvent::Log). You can set this environment variable to
1125	more talkative.	1260	a numerical loglevel to make AnyEvent more (or less) talkative.
1126		1261
		1262	If you want to do more than just set the global logging level you
		1263	should have a look at "PERL_ANYEVENT_LOG", which allows much more
		1264	complex specifications.
		1265
		1266	When set to 0 ("off"), then no messages whatsoever will be logged
		1267	with everything else at defaults.
		1268
1127	When set to 1 or higher, causes AnyEvent to warn about unexpected	1269	When set to 5 or higher ("warn"), AnyEvent warns about unexpected
1128	conditions, such as not being able to load the event model specified	1270	conditions, such as not being able to load the event model specified
1129	by "PERL_ANYEVENT_MODEL".	1271	by "PERL_ANYEVENT_MODEL", or a guard callback throwing an exception
		1272	- this is the minimum recommended level for use during development.
1130		1273
1131	When set to 2 or higher, cause AnyEvent to report to STDERR which	1274	When set to 7 or higher (info), AnyEvent reports which event model
1132	event model it chooses.	1275	it chooses.
1133		1276
1134	When set to 8 or higher, then AnyEvent will report extra information	1277	When set to 8 or higher (debug), then AnyEvent will report extra
1135	on which optional modules it loads and how it implements certain	1278	information on which optional modules it loads and how it implements
1136	features.	1279	certain features.
		1280
		1281	"PERL_ANYEVENT_LOG"
		1282	Accepts rather complex logging specifications. For example, you
		1283	could log all "debug" messages of some module to stderr, warnings
		1284	and above to stderr, and errors and above to syslog, with:
		1285
		1286	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		1287
		1288	For the rather extensive details, see AnyEvent::Log.
		1289
		1290	This variable is evaluated when AnyEvent (or AnyEvent::Log) is
		1291	loaded, so will take effect even before AnyEvent has initialised
		1292	itself.
		1293
		1294	Note that specifying this environment variable causes the
		1295	AnyEvent::Log module to be loaded, while "PERL_ANYEVENT_VERBOSE"
		1296	does not, so only using the latter saves a few hundred kB of memory
		1297	unless a module explicitly needs the extra features of
		1298	AnyEvent::Log.
1137		1299
1138	"PERL_ANYEVENT_STRICT"	1300	"PERL_ANYEVENT_STRICT"
1139	AnyEvent does not do much argument checking by default, as thorough	1301	AnyEvent does not do much argument checking by default, as thorough
1140	argument checking is very costly. Setting this variable to a true	1302	argument checking is very costly. Setting this variable to a true
1141	value will cause AnyEvent to load "AnyEvent::Strict" and then to	1303	value will cause AnyEvent to load "AnyEvent::Strict" and then to
…		…
1147	Unlike "use strict" (or its modern cousin, "use common::sense", it	1309	Unlike "use strict" (or its modern cousin, "use common::sense", it
1148	is definitely recommended to keep it off in production. Keeping	1310	is definitely recommended to keep it off in production. Keeping
1149	"PERL_ANYEVENT_STRICT=1" in your environment while developing	1311	"PERL_ANYEVENT_STRICT=1" in your environment while developing
1150	programs can be very useful, however.	1312	programs can be very useful, however.
1151		1313
		1314	"PERL_ANYEVENT_DEBUG_SHELL"
		1315	If this env variable is nonempty, then its contents will be
		1316	interpreted by "AnyEvent::Socket::parse_hostport" and
		1317	"AnyEvent::Debug::shell" (after replacing every occurance of $$ by
		1318	the process pid). The shell object is saved in
		1319	$AnyEvent::Debug::SHELL.
		1320
		1321	This happens when the first watcher is created.
		1322
		1323	For example, to bind a debug shell on a unix domain socket in
		1324	/tmp/debug<pid>.sock, you could use this:
		1325
		1326	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		1327	# connect with e.g.: socat readline /tmp/debug123.sock
		1328
		1329	Or to bind to tcp port 4545 on localhost:
		1330
		1331	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		1332	# connect with e.g.: telnet localhost 4545
		1333
		1334	Note that creating sockets in /tmp or on localhost is very unsafe on
		1335	multiuser systems.
		1336
		1337	"PERL_ANYEVENT_DEBUG_WRAP"
		1338	Can be set to 0, 1 or 2 and enables wrapping of all watchers for
		1339	debugging purposes. See "AnyEvent::Debug::wrap" for details.
		1340
1152	"PERL_ANYEVENT_MODEL"	1341	"PERL_ANYEVENT_MODEL"
1153	This can be used to specify the event model to be used by AnyEvent,	1342	This can be used to specify the event model to be used by AnyEvent,
1154	before auto detection and -probing kicks in. It must be a string	1343	before auto detection and -probing kicks in.
1155	consisting entirely of ASCII letters. The string "AnyEvent::Impl::"	1344
1156	gets prepended and the resulting module name is loaded and if the	1345	It normally is a string consisting entirely of ASCII letters (e.g.
1157	load was successful, used as event model. If it fails to load	1346	"EV" or "IOAsync"). The string "AnyEvent::Impl::" gets prepended and
		1347	the resulting module name is loaded and - if the load was successful
		1348	- used as event model backend. If it fails to load then AnyEvent
1158	AnyEvent will proceed with auto detection and -probing.	1349	will proceed with auto detection and -probing.
1159		1350
1160	This functionality might change in future versions.	1351	If the string ends with "::" instead (e.g. "AnyEvent::Impl::EV::")
		1352	then nothing gets prepended and the module name is used as-is (hint:
		1353	"::" at the end of a string designates a module name and quotes it
		1354	appropriately).
1161		1355
1162	For example, to force the pure perl model (AnyEvent::Impl::Perl) you	1356	For example, to force the pure perl model (AnyEvent::Loop::Perl) you
1163	could start your program like this:	1357	could start your program like this:
1164		1358
1165	PERL_ANYEVENT_MODEL=Perl perl ...	1359	PERL_ANYEVENT_MODEL=Perl perl ...
		1360
		1361	"PERL_ANYEVENT_IO_MODEL"
		1362	The current file I/O model - see AnyEvent::IO for more info.
		1363
		1364	At the moment, only "Perl" (small, pure-perl, synchronous) and
		1365	"IOAIO" (truly asynchronous) are supported. The default is "IOAIO"
		1366	if AnyEvent::AIO can be loaded, otherwise it is "Perl".
1166		1367
1167	"PERL_ANYEVENT_PROTOCOLS"	1368	"PERL_ANYEVENT_PROTOCOLS"
1168	Used by both AnyEvent::DNS and AnyEvent::Socket to determine	1369	Used by both AnyEvent::DNS and AnyEvent::Socket to determine
1169	preferences for IPv4 or IPv6. The default is unspecified (and might	1370	preferences for IPv4 or IPv6. The default is unspecified (and might
1170	change, or be the result of auto probing).	1371	change, or be the result of auto probing).
…		…
1174	mentioned will be used, and preference will be given to protocols	1375	mentioned will be used, and preference will be given to protocols
1175	mentioned earlier in the list.	1376	mentioned earlier in the list.
1176		1377
1177	This variable can effectively be used for denial-of-service attacks	1378	This variable can effectively be used for denial-of-service attacks
1178	against local programs (e.g. when setuid), although the impact is	1379	against local programs (e.g. when setuid), although the impact is
1179	likely small, as the program has to handle conenction and other	1380	likely small, as the program has to handle connection and other
1180	failures anyways.	1381	failures anyways.
1181		1382
1182	Examples: "PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6" - prefer IPv4 over	1383	Examples: "PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6" - prefer IPv4 over
1183	IPv6, but support both and try to use both.	1384	IPv6, but support both and try to use both.
1184	"PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to	1385	"PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to
1185	resolve or contact IPv6 addresses.	1386	resolve or contact IPv6 addresses.
1186	"PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4" support either IPv4 or IPv6, but	1387	"PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4" support either IPv4 or IPv6, but
1187	prefer IPv6 over IPv4.	1388	prefer IPv6 over IPv4.
1188		1389
		1390	"PERL_ANYEVENT_HOSTS"
		1391	This variable, if specified, overrides the /etc/hosts file used by
		1392	AnyEvent::Socket"::resolve_sockaddr", i.e. hosts aliases will be
		1393	read from that file instead.
		1394
1189	"PERL_ANYEVENT_EDNS0"	1395	"PERL_ANYEVENT_EDNS0"
1190	Used by AnyEvent::DNS to decide whether to use the EDNS0 extension	1396	Used by AnyEvent::DNS to decide whether to use the EDNS0 extension
1191	for DNS. This extension is generally useful to reduce DNS traffic,	1397	for DNS. This extension is generally useful to reduce DNS traffic,
1192	but some (broken) firewalls drop such DNS packets, which is why it	1398	especially when DNSSEC is involved, but some (broken) firewalls drop
1193	is off by default.	1399	such DNS packets, which is why it is off by default.
1194		1400
1195	Setting this variable to 1 will cause AnyEvent::DNS to announce	1401	Setting this variable to 1 will cause AnyEvent::DNS to announce
1196	EDNS0 in its DNS requests.	1402	EDNS0 in its DNS requests.
1197		1403
1198	"PERL_ANYEVENT_MAX_FORKS"	1404	"PERL_ANYEVENT_MAX_FORKS"
…		…
1202	"PERL_ANYEVENT_MAX_OUTSTANDING_DNS"	1408	"PERL_ANYEVENT_MAX_OUTSTANDING_DNS"
1203	The default value for the "max_outstanding" parameter for the	1409	The default value for the "max_outstanding" parameter for the
1204	default DNS resolver - this is the maximum number of parallel DNS	1410	default DNS resolver - this is the maximum number of parallel DNS
1205	requests that are sent to the DNS server.	1411	requests that are sent to the DNS server.
1206		1412
		1413	"PERL_ANYEVENT_MAX_SIGNAL_LATENCY"
		1414	Perl has inherently racy signal handling (you can basically choose
		1415	between losing signals and memory corruption) - pure perl event
		1416	loops (including "AnyEvent::Loop", when "Async::Interrupt" isn't
		1417	available) therefore have to poll regularly to avoid losing signals.
		1418
		1419	Some event loops are racy, but don't poll regularly, and some event
		1420	loops are written in C but are still racy. For those event loops,
		1421	AnyEvent installs a timer that regularly wakes up the event loop.
		1422
		1423	By default, the interval for this timer is 10 seconds, but you can
		1424	override this delay with this environment variable (or by setting
		1425	the $AnyEvent::MAX_SIGNAL_LATENCY variable before creating signal
		1426	watchers).
		1427
		1428	Lower values increase CPU (and energy) usage, higher values can
		1429	introduce long delays when reaping children or waiting for signals.
		1430
		1431	The AnyEvent::Async module, if available, will be used to avoid this
		1432	polling (with most event loops).
		1433
1207	"PERL_ANYEVENT_RESOLV_CONF"	1434	"PERL_ANYEVENT_RESOLV_CONF"
1208	The file to use instead of /etc/resolv.conf (or OS-specific	1435	The absolute path to a resolv.conf-style file to use instead of
1209	configuration) in the default resolver. When set to the empty	1436	/etc/resolv.conf (or the OS-specific configuration) in the default
1210	string, no default config will be used.	1437	resolver, or the empty string to select the default configuration.
1211		1438
1212	"PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH".	1439	"PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH".
1213	When neither "ca_file" nor "ca_path" was specified during	1440	When neither "ca_file" nor "ca_path" was specified during
1214	AnyEvent::TLS context creation, and either of these environment	1441	AnyEvent::TLS context creation, and either of these environment
1215	variables exist, they will be used to specify CA certificate	1442	variables are nonempty, they will be used to specify CA certificate
1216	locations instead of a system-dependent default.	1443	locations instead of a system-dependent default.
1217		1444
1218	"PERL_ANYEVENT_AVOID_GUARD" and "PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT"	1445	"PERL_ANYEVENT_AVOID_GUARD" and "PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT"
1219	When these are set to 1, then the respective modules are not loaded.	1446	When these are set to 1, then the respective modules are not loaded.
1220	Mostly good for testing AnyEvent itself.	1447	Mostly good for testing AnyEvent itself.
…		…
1392	my $txn = shift;	1619	my $txn = shift;
1393	my $data = $txn->result;	1620	my $data = $txn->result;
1394	...	1621	...
1395	});	1622	});
1396		1623
1397	EV::loop;	1624	EV::run;
1398		1625
1399	3b. The module user could use AnyEvent, too:	1626	3b. The module user could use AnyEvent, too:
1400		1627
1401	use AnyEvent;	1628	use AnyEvent;
1402		1629
…		…
1540	when used without AnyEvent), but most event loops have acceptable	1767	when used without AnyEvent), but most event loops have acceptable
1541	performance with or without AnyEvent.	1768	performance with or without AnyEvent.
1542		1769
1543	* The overhead AnyEvent adds is usually much smaller than the overhead	1770	* The overhead AnyEvent adds is usually much smaller than the overhead
1544	of the actual event loop, only with extremely fast event loops such	1771	of the actual event loop, only with extremely fast event loops such
1545	as EV adds AnyEvent significant overhead.	1772	as EV does AnyEvent add significant overhead.
1546		1773
1547	* You should avoid POE like the plague if you want performance or	1774	* You should avoid POE like the plague if you want performance or
1548	reasonable memory usage.	1775	reasonable memory usage.
1549		1776
1550	BENCHMARKING THE LARGE SERVER CASE	1777	BENCHMARKING THE LARGE SERVER CASE
…		…
1810	the help of AnyEvent::TLS), gains the ability to do TLS/SSL.	2037	the help of AnyEvent::TLS), gains the ability to do TLS/SSL.
1811		2038
1812	Time::HiRes	2039	Time::HiRes
1813	This module is part of perl since release 5.008. It will be used	2040	This module is part of perl since release 5.008. It will be used
1814	when the chosen event library does not come with a timing source of	2041	when the chosen event library does not come with a timing source of
1815	its own. The pure-perl event loop (AnyEvent::Impl::Perl) will	2042	its own. The pure-perl event loop (AnyEvent::Loop) will additionally
1816	additionally use it to try to use a monotonic clock for timing	2043	load it to try to use a monotonic clock for timing stability.
1817	stability.	2044
		2045	AnyEvent::AIO (and IO::AIO)
		2046	The default implementation of AnyEvent::IO is to do I/O
		2047	synchronously, stopping programs while they access the disk, which
		2048	is fine for a lot of programs.
		2049
		2050	Installing AnyEvent::AIO (and its IO::AIO dependency) makes it
		2051	switch to a true asynchronous implementation, so event processing
		2052	can continue even while waiting for disk I/O.
1818		2053
1819	FORK	2054	FORK
1820	Most event libraries are not fork-safe. The ones who are usually are	2055	Most event libraries are not fork-safe. The ones who are usually are
1821	because they rely on inefficient but fork-safe "select" or "poll" calls	2056	because they rely on inefficient but fork-safe "select" or "poll" calls
1822	- higher performance APIs such as BSD's kqueue or the dreaded Linux	2057	- higher performance APIs such as BSD's kqueue or the dreaded Linux
…		…
1830	usually happens when the first AnyEvent watcher is created, or the	2065	usually happens when the first AnyEvent watcher is created, or the
1831	library is loaded).	2066	library is loaded).
1832		2067
1833	If you have to fork, you must either do so before creating your first	2068	If you have to fork, you must either do so before creating your first
1834	watcher OR you must not use AnyEvent at all in the child OR you must do	2069	watcher OR you must not use AnyEvent at all in the child OR you must do
1835	something completely out of the scope of AnyEvent.	2070	something completely out of the scope of AnyEvent (see below).
1836		2071
1837	The problem of doing event processing in the parent and the child is	2072	The problem of doing event processing in the parent and the child is
1838	much more complicated: even for backends that are fork-aware or	2073	much more complicated: even for backends that are fork-aware or
1839	fork-safe, their behaviour is not usually what you want: fork clones all	2074	fork-safe, their behaviour is not usually what you want: fork clones all
1840	watchers, that means all timers, I/O watchers etc. are active in both	2075	watchers, that means all timers, I/O watchers etc. are active in both
1841	parent and child, which is almost never what you want. USing "exec" to	2076	parent and child, which is almost never what you want. Using "exec" to
1842	start worker children from some kind of manage rprocess is usually	2077	start worker children from some kind of manage prrocess is usually
1843	preferred, because it is much easier and cleaner, at the expense of	2078	preferred, because it is much easier and cleaner, at the expense of
1844	having to have another binary.	2079	having to have another binary.
		2080
		2081	In addition to logical problems with fork, there are also implementation
		2082	problems. For example, on POSIX systems, you cannot fork at all in Perl
		2083	code if a thread (I am talking of pthreads here) was ever created in the
		2084	process, and this is just the tip of the iceberg. In general, using fork
		2085	from Perl is difficult, and attempting to use fork without an exec to
		2086	implement some kind of parallel processing is almost certainly doomed.
		2087
		2088	To safely fork and exec, you should use a module such as Proc::FastSpawn
		2089	that let's you safely fork and exec new processes.
		2090
		2091	If you want to do multiprocessing using processes, you can look at the
		2092	AnyEvent::Fork module (and some related modules such as
		2093	AnyEvent::Fork::RPC, AnyEvent::Fork::Pool and AnyEvent::Fork::Remote).
		2094	This module allows you to safely create subprocesses without any
		2095	limitations - you can use X11 toolkits or AnyEvent in the children
		2096	created by AnyEvent::Fork safely and without any special precautions.
1845		2097
1846	SECURITY CONSIDERATIONS	2098	SECURITY CONSIDERATIONS
1847	AnyEvent can be forced to load any event model via	2099	AnyEvent can be forced to load any event model via
1848	$ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used	2100	$ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used
1849	to execute arbitrary code or directly gain access, it can easily be used	2101	to execute arbitrary code or directly gain access, it can easily be used
…		…
1877	SEE ALSO	2129	SEE ALSO
1878	Tutorial/Introduction: AnyEvent::Intro.	2130	Tutorial/Introduction: AnyEvent::Intro.
1879		2131
1880	FAQ: AnyEvent::FAQ.	2132	FAQ: AnyEvent::FAQ.
1881		2133
1882	Utility functions: AnyEvent::Util.	2134	Utility functions: AnyEvent::Util (misc. grab-bag), AnyEvent::Log
		2135	(simply logging).
1883		2136
1884	Event modules: EV, EV::Glib, Glib::EV, Event, Glib::Event, Glib, Tk,	2137	Development/Debugging: AnyEvent::Strict (stricter checking),
1885	Event::Lib, Qt, POE.	2138	AnyEvent::Debug (interactive shell, watcher tracing).
		2139
		2140	Supported event modules: AnyEvent::Loop, EV, EV::Glib, Glib::EV, Event,
		2141	Glib::Event, Glib, Tk, Event::Lib, Qt, POE, FLTK, Cocoa::EventLoop, UV.
1886		2142
1887	Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event,	2143	Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event,
1888	AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl,	2144	AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl,
1889	AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE,	2145	AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE,
		2146	AnyEvent::Impl::IOAsync, AnyEvent::Impl::Irssi, AnyEvent::Impl::FLTK,
1890	AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi.	2147	AnyEvent::Impl::Cocoa, AnyEvent::Impl::UV.
1891		2148
1892	Non-blocking file handles, sockets, TCP clients and servers:	2149	Non-blocking handles, pipes, stream sockets, TCP clients and servers:
1893	AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS.	2150	AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS.
		2151
		2152	Asynchronous File I/O: AnyEvent::IO.
1894		2153
1895	Asynchronous DNS: AnyEvent::DNS.	2154	Asynchronous DNS: AnyEvent::DNS.
1896		2155
1897	Thread support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event.	2156	Thread support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event.
1898		2157
1899	Nontrivial usage examples: AnyEvent::GPSD, AnyEvent::IRC,	2158	Nontrivial usage examples: AnyEvent::GPSD, AnyEvent::IRC,
1900	AnyEvent::HTTP.	2159	AnyEvent::HTTP.
1901		2160
1902	AUTHOR	2161	AUTHOR
1903	Marc Lehmann <schmorp@schmorp.de>	2162	Marc Lehmann <schmorp@schmorp.de>
1904	http://home.schmorp.de/	2163	http://anyevent.schmorp.de
1905		2164

Diff Legend

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

Comparing AnyEvent/README (file contents): Revision 1.63 by root, Wed Oct 13 19:49:46 2010 UTC vs. Revision 1.79 by root, Tue Feb 26 02:08:34 2019 UTC

Diff Legend

Comparing AnyEvent/README (file contents):
Revision 1.63 by root, Wed Oct 13 19:49:46 2010 UTC vs.
Revision 1.79 by root, Tue Feb 26 02:08:34 2019 UTC