ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.19 by root, Sun Dec 10 23:59:15 2006 UTC vs.
Revision 1.176 by root, Wed Aug 20 12:37:21 2008 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - provide framework for multiple event loops
4		4
5	Event, Coro, Glib, Tk, Perl - various supported event loops	5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	use AnyEvent;	9	use AnyEvent;
10		10
11	my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub {	11	my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... });
		12
		13	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
		14	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
		15
		16	print AnyEvent->now; # prints current event loop time
		17	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
		18
		19	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
		20
		21	my $w = AnyEvent->child (pid => $pid, cb => sub {
		22	my ($pid, $status) = @_;
12	...	23	...
13	});	24	});
14		25
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {
16	...
17	});
18
19	my $w = AnyEvent->condvar; # stores wether a condition was flagged	26	my $w = AnyEvent->condvar; # stores whether a condition was flagged
		27	$w->send; # wake up current and all future recv's
20	$w->wait; # enters "main loop" till $condvar gets ->broadcast	28	$w->recv; # enters "main loop" till $condvar gets ->send
21	$w->broadcast; # wake up current and all future wait's	29	# use a condvar in callback mode:
		30	$w->cb (sub { $_[0]->recv });
		31
		32	=head1 INTRODUCTION/TUTORIAL
		33
		34	This manpage is mainly a reference manual. If you are interested
		35	in a tutorial or some gentle introduction, have a look at the
		36	L<AnyEvent::Intro> manpage.
		37
		38	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
		39
		40	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
		41	nowadays. So what is different about AnyEvent?
		42
		43	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
		44	policy> and AnyEvent is I<small and efficient>.
		45
		46	First and foremost, I<AnyEvent is not an event model> itself, it only
		47	interfaces to whatever event model the main program happens to use, in a
		48	pragmatic way. For event models and certain classes of immortals alike,
		49	the statement "there can only be one" is a bitter reality: In general,
		50	only one event loop can be active at the same time in a process. AnyEvent
		51	cannot change this, but it can hide the differences between those event
		52	loops.
		53
		54	The goal of AnyEvent is to offer module authors the ability to do event
		55	programming (waiting for I/O or timer events) without subscribing to a
		56	religion, a way of living, and most importantly: without forcing your
		57	module users into the same thing by forcing them to use the same event
		58	model you use.
		59
		60	For modules like POE or IO::Async (which is a total misnomer as it is
		61	actually doing all I/O I<synchronously>...), using them in your module is
		62	like joining a cult: After you joined, you are dependent on them and you
		63	cannot use anything else, as they are simply incompatible to everything
		64	that isn't them. What's worse, all the potential users of your
		65	module are I<also> forced to use the same event loop you use.
		66
		67	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
		68	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
		69	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
		70	your module uses one of those, every user of your module has to use it,
		71	too. But if your module uses AnyEvent, it works transparently with all
		72	event models it supports (including stuff like IO::Async, as long as those
		73	use one of the supported event loops. It is trivial to add new event loops
		74	to AnyEvent, too, so it is future-proof).
		75
		76	In addition to being free of having to use I<the one and only true event
		77	model>, AnyEvent also is free of bloat and policy: with POE or similar
		78	modules, you get an enormous amount of code and strict rules you have to
		79	follow. AnyEvent, on the other hand, is lean and up to the point, by only
		80	offering the functionality that is necessary, in as thin as a wrapper as
		81	technically possible.
		82
		83	Of course, AnyEvent comes with a big (and fully optional!) toolbox
		84	of useful functionality, such as an asynchronous DNS resolver, 100%
		85	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
		86	such as Windows) and lots of real-world knowledge and workarounds for
		87	platform bugs and differences.
		88
		89	Now, if you I<do want> lots of policy (this can arguably be somewhat
		90	useful) and you want to force your users to use the one and only event
		91	model, you should I<not> use this module.
22		92
23	=head1 DESCRIPTION	93	=head1 DESCRIPTION
24		94
25	L<AnyEvent> provides an identical interface to multiple event loops. This	95	L<AnyEvent> provides an identical interface to multiple event loops. This
26	allows module authors to utilise an event loop without forcing module	96	allows module authors to utilise an event loop without forcing module
27	users to use the same event loop (as only a single event loop can coexist	97	users to use the same event loop (as only a single event loop can coexist
28	peacefully at any one time).	98	peacefully at any one time).
29		99
30	The interface itself is vaguely similar but not identical to the Event	100	The interface itself is vaguely similar, but not identical to the L<Event>
31	module.	101	module.
32		102
33	On the first call of any method, the module tries to detect the currently	103	During the first call of any watcher-creation method, the module tries
34	loaded event loop by probing wether any of the following modules is	104	to detect the currently loaded event loop by probing whether one of the
35	loaded: L<Coro::Event>, L<Event>, L<Glib>, L<Tk>. The first one found is	105	following modules is already loaded: L<EV>,
36	used. If none is found, the module tries to load these modules in the	106	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,
37	order given. The first one that could be successfully loaded will be	107	L<POE>. The first one found is used. If none are found, the module tries
38	used. If still none could be found, AnyEvent will fall back to a pure-perl	108	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl
39	event loop, which is also not very efficient.	109	adaptor should always succeed) in the order given. The first one that can
		110	be successfully loaded will be used. If, after this, still none could be
		111	found, AnyEvent will fall back to a pure-perl event loop, which is not
		112	very efficient, but should work everywhere.
40		113
41	Because AnyEvent first checks for modules that are already loaded, loading	114	Because AnyEvent first checks for modules that are already loaded, loading
42	an Event model explicitly before first using AnyEvent will likely make	115	an event model explicitly before first using AnyEvent will likely make
43	that model the default. For example:	116	that model the default. For example:
44		117
45	use Tk;	118	use Tk;
46	use AnyEvent;	119	use AnyEvent;
47		120
48	# .. AnyEvent will likely default to Tk	121	# .. AnyEvent will likely default to Tk
49		122
		123	The I<likely> means that, if any module loads another event model and
		124	starts using it, all bets are off. Maybe you should tell their authors to
		125	use AnyEvent so their modules work together with others seamlessly...
		126
50	The pure-perl implementation of AnyEvent is called	127	The pure-perl implementation of AnyEvent is called
51	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	128	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
52	explicitly.	129	explicitly and enjoy the high availability of that event loop :)
53		130
54	=head1 WATCHERS	131	=head1 WATCHERS
55		132
56	AnyEvent has the central concept of a I<watcher>, which is an object that	133	AnyEvent has the central concept of a I<watcher>, which is an object that
57	stores relevant data for each kind of event you are waiting for, such as	134	stores relevant data for each kind of event you are waiting for, such as
58	the callback to call, the filehandle to watch, etc.	135	the callback to call, the file handle to watch, etc.
59		136
60	These watchers are normal Perl objects with normal Perl lifetime. After	137	These watchers are normal Perl objects with normal Perl lifetime. After
61	creating a watcher it will immediately "watch" for events and invoke	138	creating a watcher it will immediately "watch" for events and invoke the
		139	callback when the event occurs (of course, only when the event model
		140	is in control).
		141
62	the callback. To disable the watcher you have to destroy it (e.g. by	142	To disable the watcher you have to destroy it (e.g. by setting the
63	setting the variable that stores it to C<undef> or otherwise deleting all	143	variable you store it in to C<undef> or otherwise deleting all references
64	references to it).	144	to it).
65		145
66	All watchers are created by calling a method on the C<AnyEvent> class.	146	All watchers are created by calling a method on the C<AnyEvent> class.
67		147
		148	Many watchers either are used with "recursion" (repeating timers for
		149	example), or need to refer to their watcher object in other ways.
		150
		151	An any way to achieve that is this pattern:
		152
		153	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
		154	# you can use $w here, for example to undef it
		155	undef $w;
		156	});
		157
		158	Note that C<my $w; $w => combination. This is necessary because in Perl,
		159	my variables are only visible after the statement in which they are
		160	declared.
		161
68	=head2 IO WATCHERS	162	=head2 I/O WATCHERS
69		163
70	You can create I/O watcher by calling the C<< AnyEvent->io >> method with	164	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
71	the following mandatory arguments:	165	with the following mandatory key-value pairs as arguments:
72		166
73	C<fh> the Perl I<filehandle> (not filedescriptor) to watch for	167	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events
		168	(AnyEvent might or might not keep a reference to this file handle). C<poll>
74	events. C<poll> must be a string that is either C<r> or C<w>, that creates	169	must be a string that is either C<r> or C<w>, which creates a watcher
75	a watcher waiting for "r"eadable or "w"ritable events. C<cb> teh callback	170	waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
76	to invoke everytime the filehandle becomes ready.	171	callback to invoke each time the file handle becomes ready.
77		172
78	Only one io watcher per C<fh> and C<poll> combination is allowed (i.e. on	173	Although the callback might get passed parameters, their value and
79	a socket you can have one r + one w, not any more (limitation comes from	174	presence is undefined and you cannot rely on them. Portable AnyEvent
80	Tk - if you are sure you are not using Tk this limitation is gone).	175	callbacks cannot use arguments passed to I/O watcher callbacks.
81		176
82	Filehandles will be kept alive, so as long as the watcher exists, the	177	The I/O watcher might use the underlying file descriptor or a copy of it.
83	filehandle exists, too.	178	You must not close a file handle as long as any watcher is active on the
		179	underlying file descriptor.
84		180
85	Example:	181	Some event loops issue spurious readyness notifications, so you should
		182	always use non-blocking calls when reading/writing from/to your file
		183	handles.
86		184
87	# wait for readability of STDIN, then read a line and disable the watcher	185	Example: wait for readability of STDIN, then read a line and disable the
		186	watcher.
		187
88	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	188	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
89	chomp (my $input = <STDIN>);	189	chomp (my $input = <STDIN>);
90	warn "read: $input\n";	190	warn "read: $input\n";
91	undef $w;	191	undef $w;
92	});	192	});
…		…
94	=head2 TIME WATCHERS	194	=head2 TIME WATCHERS
95		195
96	You can create a time watcher by calling the C<< AnyEvent->timer >>	196	You can create a time watcher by calling the C<< AnyEvent->timer >>
97	method with the following mandatory arguments:	197	method with the following mandatory arguments:
98		198
99	C<after> after how many seconds (fractions are supported) should the timer	199	C<after> specifies after how many seconds (fractional values are
100	activate. C<cb> the callback to invoke.	200	supported) the callback should be invoked. C<cb> is the callback to invoke
		201	in that case.
101		202
102	The timer callback will be invoked at most once: if you want a repeating	203	Although the callback might get passed parameters, their value and
103	timer you have to create a new watcher (this is a limitation by both Tk	204	presence is undefined and you cannot rely on them. Portable AnyEvent
104	and Glib).	205	callbacks cannot use arguments passed to time watcher callbacks.
105		206
106	Example:	207	The callback will normally be invoked once only. If you specify another
		208	parameter, C<interval>, as a strictly positive number (> 0), then the
		209	callback will be invoked regularly at that interval (in fractional
		210	seconds) after the first invocation. If C<interval> is specified with a
		211	false value, then it is treated as if it were missing.
107		212
		213	The callback will be rescheduled before invoking the callback, but no
		214	attempt is done to avoid timer drift in most backends, so the interval is
		215	only approximate.
		216
108	# fire an event after 7.7 seconds	217	Example: fire an event after 7.7 seconds.
		218
109	my $w = AnyEvent->timer (after => 7.7, cb => sub {	219	my $w = AnyEvent->timer (after => 7.7, cb => sub {
110	warn "timeout\n";	220	warn "timeout\n";
111	});	221	});
112		222
113	# to cancel the timer:	223	# to cancel the timer:
114	undef $w	224	undef $w;
115		225
116	=head2 CONDITION WATCHERS	226	Example 2: fire an event after 0.5 seconds, then roughly every second.
117		227
118	Condition watchers can be created by calling the C<< AnyEvent->condvar >>	228	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
119	method without any arguments.	229	warn "timeout\n";
		230	};
120		231
121	A condition watcher watches for a condition - precisely that the C<<	232	=head3 TIMING ISSUES
122	->broadcast >> method has been called.
123		233
124	The watcher has only two methods:	234	There are two ways to handle timers: based on real time (relative, "fire
		235	in 10 seconds") and based on wallclock time (absolute, "fire at 12
		236	o'clock").
		237
		238	While most event loops expect timers to specified in a relative way, they
		239	use absolute time internally. This makes a difference when your clock
		240	"jumps", for example, when ntp decides to set your clock backwards from
		241	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
		242	fire "after" a second might actually take six years to finally fire.
		243
		244	AnyEvent cannot compensate for this. The only event loop that is conscious
		245	about these issues is L<EV>, which offers both relative (ev_timer, based
		246	on true relative time) and absolute (ev_periodic, based on wallclock time)
		247	timers.
		248
		249	AnyEvent always prefers relative timers, if available, matching the
		250	AnyEvent API.
		251
		252	AnyEvent has two additional methods that return the "current time":
125		253
126	=over 4	254	=over 4
127		255
128	=item $cv->wait	256	=item AnyEvent->time
129		257
130	Wait (blocking if necessary) until the C<< ->broadcast >> method has been	258	This returns the "current wallclock time" as a fractional number of
131	called on c<$cv>, while servicing other watchers normally.	259	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
		260	return, and the result is guaranteed to be compatible with those).
132		261
133	Not all event models support a blocking wait - some die in that case, so	262	It progresses independently of any event loop processing, i.e. each call
134	if you are using this from a module, never require a blocking wait, but	263	will check the system clock, which usually gets updated frequently.
135	let the caller decide wether the call will block or not (for example,
136	by coupling condition variables with some kind of request results and
137	supporting callbacks so the caller knows that getting the result will not
138	block, while still suppporting blockign waits if the caller so desires).
139		264
140	You can only wait once on a condition - additional calls will return	265	=item AnyEvent->now
141	immediately.
142		266
143	=item $cv->broadcast	267	This also returns the "current wallclock time", but unlike C<time>, above,
		268	this value might change only once per event loop iteration, depending on
		269	the event loop (most return the same time as C<time>, above). This is the
		270	time that AnyEvent's timers get scheduled against.
144		271
145	Flag the condition as ready - a running C<< ->wait >> and all further	272	I<In almost all cases (in all cases if you don't care), this is the
146	calls to C<wait> will return after this method has been called. If nobody	273	function to call when you want to know the current time.>
147	is waiting the broadcast will be remembered..
148		274
149	Example:	275	This function is also often faster then C<< AnyEvent->time >>, and
		276	thus the preferred method if you want some timestamp (for example,
		277	L<AnyEvent::Handle> uses this to update it's activity timeouts).
		278
		279	The rest of this section is only of relevance if you try to be very exact
		280	with your timing, you can skip it without bad conscience.
		281
		282	For a practical example of when these times differ, consider L<Event::Lib>
		283	and L<EV> and the following set-up:
		284
		285	The event loop is running and has just invoked one of your callback at
		286	time=500 (assume no other callbacks delay processing). In your callback,
		287	you wait a second by executing C<sleep 1> (blocking the process for a
		288	second) and then (at time=501) you create a relative timer that fires
		289	after three seconds.
		290
		291	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
		292	both return C<501>, because that is the current time, and the timer will
		293	be scheduled to fire at time=504 (C<501> + C<3>).
		294
		295	With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
		296	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
		297	last event processing phase started. With L<EV>, your timer gets scheduled
		298	to run at time=503 (C<500> + C<3>).
		299
		300	In one sense, L<Event::Lib> is more exact, as it uses the current time
		301	regardless of any delays introduced by event processing. However, most
		302	callbacks do not expect large delays in processing, so this causes a
		303	higher drift (and a lot more system calls to get the current time).
		304
		305	In another sense, L<EV> is more exact, as your timer will be scheduled at
		306	the same time, regardless of how long event processing actually took.
		307
		308	In either case, if you care (and in most cases, you don't), then you
		309	can get whatever behaviour you want with any event loop, by taking the
		310	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
		311	account.
		312
		313	=back
		314
		315	=head2 SIGNAL WATCHERS
		316
		317	You can watch for signals using a signal watcher, C<signal> is the signal
		318	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
		319	callback to be invoked whenever a signal occurs.
		320
		321	Although the callback might get passed parameters, their value and
		322	presence is undefined and you cannot rely on them. Portable AnyEvent
		323	callbacks cannot use arguments passed to signal watcher callbacks.
		324
		325	Multiple signal occurrences can be clumped together into one callback
		326	invocation, and callback invocation will be synchronous. Synchronous means
		327	that it might take a while until the signal gets handled by the process,
		328	but it is guaranteed not to interrupt any other callbacks.
		329
		330	The main advantage of using these watchers is that you can share a signal
		331	between multiple watchers.
		332
		333	This watcher might use C<%SIG>, so programs overwriting those signals
		334	directly will likely not work correctly.
		335
		336	Example: exit on SIGINT
		337
		338	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		339
		340	=head2 CHILD PROCESS WATCHERS
		341
		342	You can also watch on a child process exit and catch its exit status.
		343
		344	The child process is specified by the C<pid> argument (if set to C<0>, it
		345	watches for any child process exit). The watcher will trigger as often
		346	as status change for the child are received. This works by installing a
		347	signal handler for C<SIGCHLD>. The callback will be called with the pid
		348	and exit status (as returned by waitpid), so unlike other watcher types,
		349	you I<can> rely on child watcher callback arguments.
		350
		351	There is a slight catch to child watchers, however: you usually start them
		352	I<after> the child process was created, and this means the process could
		353	have exited already (and no SIGCHLD will be sent anymore).
		354
		355	Not all event models handle this correctly (POE doesn't), but even for
		356	event models that I<do> handle this correctly, they usually need to be
		357	loaded before the process exits (i.e. before you fork in the first place).
		358
		359	This means you cannot create a child watcher as the very first thing in an
		360	AnyEvent program, you I<have> to create at least one watcher before you
		361	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
		362
		363	Example: fork a process and wait for it
		364
		365	my $done = AnyEvent->condvar;
		366
		367	my $pid = fork or exit 5;
		368
		369	my $w = AnyEvent->child (
		370	pid => $pid,
		371	cb => sub {
		372	my ($pid, $status) = @_;
		373	warn "pid $pid exited with status $status";
		374	$done->send;
		375	},
		376	);
		377
		378	# do something else, then wait for process exit
		379	$done->recv;
		380
		381	=head2 CONDITION VARIABLES
		382
		383	If you are familiar with some event loops you will know that all of them
		384	require you to run some blocking "loop", "run" or similar function that
		385	will actively watch for new events and call your callbacks.
		386
		387	AnyEvent is different, it expects somebody else to run the event loop and
		388	will only block when necessary (usually when told by the user).
		389
		390	The instrument to do that is called a "condition variable", so called
		391	because they represent a condition that must become true.
		392
		393	Condition variables can be created by calling the C<< AnyEvent->condvar
		394	>> method, usually without arguments. The only argument pair allowed is
		395
		396	C<cb>, which specifies a callback to be called when the condition variable
		397	becomes true, with the condition variable as the first argument (but not
		398	the results).
		399
		400	After creation, the condition variable is "false" until it becomes "true"
		401	by calling the C<send> method (or calling the condition variable as if it
		402	were a callback, read about the caveats in the description for the C<<
		403	->send >> method).
		404
		405	Condition variables are similar to callbacks, except that you can
		406	optionally wait for them. They can also be called merge points - points
		407	in time where multiple outstanding events have been processed. And yet
		408	another way to call them is transactions - each condition variable can be
		409	used to represent a transaction, which finishes at some point and delivers
		410	a result.
		411
		412	Condition variables are very useful to signal that something has finished,
		413	for example, if you write a module that does asynchronous http requests,
		414	then a condition variable would be the ideal candidate to signal the
		415	availability of results. The user can either act when the callback is
		416	called or can synchronously C<< ->recv >> for the results.
		417
		418	You can also use them to simulate traditional event loops - for example,
		419	you can block your main program until an event occurs - for example, you
		420	could C<< ->recv >> in your main program until the user clicks the Quit
		421	button of your app, which would C<< ->send >> the "quit" event.
		422
		423	Note that condition variables recurse into the event loop - if you have
		424	two pieces of code that call C<< ->recv >> in a round-robin fashion, you
		425	lose. Therefore, condition variables are good to export to your caller, but
		426	you should avoid making a blocking wait yourself, at least in callbacks,
		427	as this asks for trouble.
		428
		429	Condition variables are represented by hash refs in perl, and the keys
		430	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
		431	easy (it is often useful to build your own transaction class on top of
		432	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
		433	it's C<new> method in your own C<new> method.
		434
		435	There are two "sides" to a condition variable - the "producer side" which
		436	eventually calls C<< -> send >>, and the "consumer side", which waits
		437	for the send to occur.
		438
		439	Example: wait for a timer.
150		440
151	# wait till the result is ready	441	# wait till the result is ready
152	my $result_ready = AnyEvent->condvar;	442	my $result_ready = AnyEvent->condvar;
153		443
154	# do something such as adding a timer	444	# do something such as adding a timer
155	# or socket watcher the calls $result_ready->broadcast	445	# or socket watcher the calls $result_ready->send
156	# when the "result" is ready.	446	# when the "result" is ready.
		447	# in this case, we simply use a timer:
		448	my $w = AnyEvent->timer (
		449	after => 1,
		450	cb => sub { $result_ready->send },
		451	);
157		452
		453	# this "blocks" (while handling events) till the callback
		454	# calls send
158	$result_ready->wait;	455	$result_ready->recv;
		456
		457	Example: wait for a timer, but take advantage of the fact that
		458	condition variables are also code references.
		459
		460	my $done = AnyEvent->condvar;
		461	my $delay = AnyEvent->timer (after => 5, cb => $done);
		462	$done->recv;
		463
		464	Example: Imagine an API that returns a condvar and doesn't support
		465	callbacks. This is how you make a synchronous call, for example from
		466	the main program:
		467
		468	use AnyEvent::CouchDB;
		469
		470	...
		471
		472	my @info = $couchdb->info->recv;
		473
		474	And this is how you would just ste a callback to be called whenever the
		475	results are available:
		476
		477	$couchdb->info->cb (sub {
		478	my @info = $_[0]->recv;
		479	});
		480
		481	=head3 METHODS FOR PRODUCERS
		482
		483	These methods should only be used by the producing side, i.e. the
		484	code/module that eventually sends the signal. Note that it is also
		485	the producer side which creates the condvar in most cases, but it isn't
		486	uncommon for the consumer to create it as well.
		487
		488	=over 4
		489
		490	=item $cv->send (...)
		491
		492	Flag the condition as ready - a running C<< ->recv >> and all further
		493	calls to C<recv> will (eventually) return after this method has been
		494	called. If nobody is waiting the send will be remembered.
		495
		496	If a callback has been set on the condition variable, it is called
		497	immediately from within send.
		498
		499	Any arguments passed to the C<send> call will be returned by all
		500	future C<< ->recv >> calls.
		501
		502	Condition variables are overloaded so one can call them directly
		503	(as a code reference). Calling them directly is the same as calling
		504	C<send>. Note, however, that many C-based event loops do not handle
		505	overloading, so as tempting as it may be, passing a condition variable
		506	instead of a callback does not work. Both the pure perl and EV loops
		507	support overloading, however, as well as all functions that use perl to
		508	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
		509	example).
		510
		511	=item $cv->croak ($error)
		512
		513	Similar to send, but causes all call's to C<< ->recv >> to invoke
		514	C<Carp::croak> with the given error message/object/scalar.
		515
		516	This can be used to signal any errors to the condition variable
		517	user/consumer.
		518
		519	=item $cv->begin ([group callback])
		520
		521	=item $cv->end
		522
		523	These two methods are EXPERIMENTAL and MIGHT CHANGE.
		524
		525	These two methods can be used to combine many transactions/events into
		526	one. For example, a function that pings many hosts in parallel might want
		527	to use a condition variable for the whole process.
		528
		529	Every call to C<< ->begin >> will increment a counter, and every call to
		530	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
		531	>>, the (last) callback passed to C<begin> will be executed. That callback
		532	is I<supposed> to call C<< ->send >>, but that is not required. If no
		533	callback was set, C<send> will be called without any arguments.
		534
		535	Let's clarify this with the ping example:
		536
		537	my $cv = AnyEvent->condvar;
		538
		539	my %result;
		540	$cv->begin (sub { $cv->send (\%result) });
		541
		542	for my $host (@list_of_hosts) {
		543	$cv->begin;
		544	ping_host_then_call_callback $host, sub {
		545	$result{$host} = ...;
		546	$cv->end;
		547	};
		548	}
		549
		550	$cv->end;
		551
		552	This code fragment supposedly pings a number of hosts and calls
		553	C<send> after results for all then have have been gathered - in any
		554	order. To achieve this, the code issues a call to C<begin> when it starts
		555	each ping request and calls C<end> when it has received some result for
		556	it. Since C<begin> and C<end> only maintain a counter, the order in which
		557	results arrive is not relevant.
		558
		559	There is an additional bracketing call to C<begin> and C<end> outside the
		560	loop, which serves two important purposes: first, it sets the callback
		561	to be called once the counter reaches C<0>, and second, it ensures that
		562	C<send> is called even when C<no> hosts are being pinged (the loop
		563	doesn't execute once).
		564
		565	This is the general pattern when you "fan out" into multiple subrequests:
		566	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
		567	is called at least once, and then, for each subrequest you start, call
		568	C<begin> and for each subrequest you finish, call C<end>.
159		569
160	=back	570	=back
161		571
162	=head2 SIGNAL WATCHERS	572	=head3 METHODS FOR CONSUMERS
163		573
164	You can listen for signals using a signal watcher, C<signal> is the signal	574	These methods should only be used by the consuming side, i.e. the
165	I<name> without any C<SIG> prefix.	575	code awaits the condition.
166		576
167	These watchers might use C<%SIG>, so programs overwriting those signals	577	=over 4
168	directly will likely not work correctly.
169		578
170	Example: exit on SIGINT	579	=item $cv->recv
171		580
172	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	581	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
		582	>> methods have been called on c<$cv>, while servicing other watchers
		583	normally.
173		584
174	=head1 GLOBALS	585	You can only wait once on a condition - additional calls are valid but
		586	will return immediately.
		587
		588	If an error condition has been set by calling C<< ->croak >>, then this
		589	function will call C<croak>.
		590
		591	In list context, all parameters passed to C<send> will be returned,
		592	in scalar context only the first one will be returned.
		593
		594	Not all event models support a blocking wait - some die in that case
		595	(programs might want to do that to stay interactive), so I<if you are
		596	using this from a module, never require a blocking wait>, but let the
		597	caller decide whether the call will block or not (for example, by coupling
		598	condition variables with some kind of request results and supporting
		599	callbacks so the caller knows that getting the result will not block,
		600	while still supporting blocking waits if the caller so desires).
		601
		602	Another reason I<never> to C<< ->recv >> in a module is that you cannot
		603	sensibly have two C<< ->recv >>'s in parallel, as that would require
		604	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
		605	can supply.
		606
		607	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
		608	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
		609	versions and also integrates coroutines into AnyEvent, making blocking
		610	C<< ->recv >> calls perfectly safe as long as they are done from another
		611	coroutine (one that doesn't run the event loop).
		612
		613	You can ensure that C<< -recv >> never blocks by setting a callback and
		614	only calling C<< ->recv >> from within that callback (or at a later
		615	time). This will work even when the event loop does not support blocking
		616	waits otherwise.
		617
		618	=item $bool = $cv->ready
		619
		620	Returns true when the condition is "true", i.e. whether C<send> or
		621	C<croak> have been called.
		622
		623	=item $cb = $cv->cb ($cb->($cv))
		624
		625	This is a mutator function that returns the callback set and optionally
		626	replaces it before doing so.
		627
		628	The callback will be called when the condition becomes "true", i.e. when
		629	C<send> or C<croak> are called, with the only argument being the condition
		630	variable itself. Calling C<recv> inside the callback or at any later time
		631	is guaranteed not to block.
		632
		633	=back
		634
		635	=head1 GLOBAL VARIABLES AND FUNCTIONS
175		636
176	=over 4	637	=over 4
177		638
178	=item $AnyEvent::MODEL	639	=item $AnyEvent::MODEL
179		640
…		…
183	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	644	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
184	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	645	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
185		646
186	The known classes so far are:	647	The known classes so far are:
187		648
188	AnyEvent::Impl::Coro based on Coro::Event, best choise.	649	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
189	AnyEvent::Impl::Event based on Event, also best choice :)	650	AnyEvent::Impl::Event based on Event, second best choice.
		651	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
190	AnyEvent::Impl::Glib based on Glib, second-best choice.	652	AnyEvent::Impl::Glib based on Glib, third-best choice.
191	AnyEvent::Impl::Tk based on Tk, very bad choice.	653	AnyEvent::Impl::Tk based on Tk, very bad choice.
192	AnyEvent::Impl::Perl pure-perl implementation, inefficient.	654	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
		655	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		656	AnyEvent::Impl::POE based on POE, not generic enough for full support.
		657
		658	There is no support for WxWidgets, as WxWidgets has no support for
		659	watching file handles. However, you can use WxWidgets through the
		660	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
		661	second, which was considered to be too horrible to even consider for
		662	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
		663	it's adaptor.
		664
		665	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
		666	autodetecting them.
193		667
194	=item AnyEvent::detect	668	=item AnyEvent::detect
195		669
196	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if	670	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
197	necessary. You should only call this function right before you would have	671	if necessary. You should only call this function right before you would
198	created an AnyEvent watcher anyway, that is, very late at runtime.	672	have created an AnyEvent watcher anyway, that is, as late as possible at
		673	runtime.
		674
		675	=item $guard = AnyEvent::post_detect { BLOCK }
		676
		677	Arranges for the code block to be executed as soon as the event model is
		678	autodetected (or immediately if this has already happened).
		679
		680	If called in scalar or list context, then it creates and returns an object
		681	that automatically removes the callback again when it is destroyed. See
		682	L<Coro::BDB> for a case where this is useful.
		683
		684	=item @AnyEvent::post_detect
		685
		686	If there are any code references in this array (you can C<push> to it
		687	before or after loading AnyEvent), then they will called directly after
		688	the event loop has been chosen.
		689
		690	You should check C<$AnyEvent::MODEL> before adding to this array, though:
		691	if it contains a true value then the event loop has already been detected,
		692	and the array will be ignored.
		693
		694	Best use C<AnyEvent::post_detect { BLOCK }> instead.
199		695
200	=back	696	=back
201		697
202	=head1 WHAT TO DO IN A MODULE	698	=head1 WHAT TO DO IN A MODULE
203		699
204	As a module author, you should "use AnyEvent" and call AnyEvent methods	700	As a module author, you should C<use AnyEvent> and call AnyEvent methods
205	freely, but you should not load a specific event module or rely on it.	701	freely, but you should not load a specific event module or rely on it.
206		702
207	Be careful when you create watchers in the module body - Anyevent will	703	Be careful when you create watchers in the module body - AnyEvent will
208	decide which event module to use as soon as the first method is called, so	704	decide which event module to use as soon as the first method is called, so
209	by calling AnyEvent in your module body you force the user of your module	705	by calling AnyEvent in your module body you force the user of your module
210	to load the event module first.	706	to load the event module first.
211		707
		708	Never call C<< ->recv >> on a condition variable unless you I<know> that
		709	the C<< ->send >> method has been called on it already. This is
		710	because it will stall the whole program, and the whole point of using
		711	events is to stay interactive.
		712
		713	It is fine, however, to call C<< ->recv >> when the user of your module
		714	requests it (i.e. if you create a http request object ad have a method
		715	called C<results> that returns the results, it should call C<< ->recv >>
		716	freely, as the user of your module knows what she is doing. always).
		717
212	=head1 WHAT TO DO IN THE MAIN PROGRAM	718	=head1 WHAT TO DO IN THE MAIN PROGRAM
213		719
214	There will always be a single main program - the only place that should	720	There will always be a single main program - the only place that should
215	dictate which event model to use.	721	dictate which event model to use.
216		722
217	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	723	If it doesn't care, it can just "use AnyEvent" and use it itself, or not
218	do anything special and let AnyEvent decide which implementation to chose.	724	do anything special (it does not need to be event-based) and let AnyEvent
		725	decide which implementation to chose if some module relies on it.
219		726
220	If the main program relies on a specific event model (for example, in Gtk2	727	If the main program relies on a specific event model - for example, in
221	programs you have to rely on either Glib or Glib::Event), you should load	728	Gtk2 programs you have to rely on the Glib module - you should load the
222	it before loading AnyEvent or any module that uses it, generally, as early	729	event module before loading AnyEvent or any module that uses it: generally
223	as possible. The reason is that modules might create watchers when they	730	speaking, you should load it as early as possible. The reason is that
224	are loaded, and AnyEvent will decide on the event model to use as soon as	731	modules might create watchers when they are loaded, and AnyEvent will
225	it creates watchers, and it might chose the wrong one unless you load the	732	decide on the event model to use as soon as it creates watchers, and it
226	correct one yourself.	733	might chose the wrong one unless you load the correct one yourself.
227		734
228	You can chose to use a rather inefficient pure-perl implementation by	735	You can chose to use a pure-perl implementation by loading the
229	loading the C<AnyEvent::Impl::Perl> module, but letting AnyEvent chose is	736	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
230	generally better.	737	everywhere, but letting AnyEvent chose the model is generally better.
		738
		739	=head2 MAINLOOP EMULATION
		740
		741	Sometimes (often for short test scripts, or even standalone programs who
		742	only want to use AnyEvent), you do not want to run a specific event loop.
		743
		744	In that case, you can use a condition variable like this:
		745
		746	AnyEvent->condvar->recv;
		747
		748	This has the effect of entering the event loop and looping forever.
		749
		750	Note that usually your program has some exit condition, in which case
		751	it is better to use the "traditional" approach of storing a condition
		752	variable somewhere, waiting for it, and sending it when the program should
		753	exit cleanly.
		754
		755
		756	=head1 OTHER MODULES
		757
		758	The following is a non-exhaustive list of additional modules that use
		759	AnyEvent and can therefore be mixed easily with other AnyEvent modules
		760	in the same program. Some of the modules come with AnyEvent, some are
		761	available via CPAN.
		762
		763	=over 4
		764
		765	=item L<AnyEvent::Util>
		766
		767	Contains various utility functions that replace often-used but blocking
		768	functions such as C<inet_aton> by event-/callback-based versions.
		769
		770	=item L<AnyEvent::Socket>
		771
		772	Provides various utility functions for (internet protocol) sockets,
		773	addresses and name resolution. Also functions to create non-blocking tcp
		774	connections or tcp servers, with IPv6 and SRV record support and more.
		775
		776	=item L<AnyEvent::Handle>
		777
		778	Provide read and write buffers, manages watchers for reads and writes,
		779	supports raw and formatted I/O, I/O queued and fully transparent and
		780	non-blocking SSL/TLS.
		781
		782	=item L<AnyEvent::DNS>
		783
		784	Provides rich asynchronous DNS resolver capabilities.
		785
		786	=item L<AnyEvent::HTTP>
		787
		788	A simple-to-use HTTP library that is capable of making a lot of concurrent
		789	HTTP requests.
		790
		791	=item L<AnyEvent::HTTPD>
		792
		793	Provides a simple web application server framework.
		794
		795	=item L<AnyEvent::FastPing>
		796
		797	The fastest ping in the west.
		798
		799	=item L<AnyEvent::DBI>
		800
		801	Executes L<DBI> requests asynchronously in a proxy process.
		802
		803	=item L<AnyEvent::AIO>
		804
		805	Truly asynchronous I/O, should be in the toolbox of every event
		806	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
		807	together.
		808
		809	=item L<AnyEvent::BDB>
		810
		811	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
		812	L<BDB> and AnyEvent together.
		813
		814	=item L<AnyEvent::GPSD>
		815
		816	A non-blocking interface to gpsd, a daemon delivering GPS information.
		817
		818	=item L<AnyEvent::IGS>
		819
		820	A non-blocking interface to the Internet Go Server protocol (used by
		821	L<App::IGS>).
		822
		823	=item L<Net::IRC3>
		824
		825	AnyEvent based IRC client module family.
		826
		827	=item L<Net::XMPP2>
		828
		829	AnyEvent based XMPP (Jabber protocol) module family.
		830
		831	=item L<Net::FCP>
		832
		833	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
		834	of AnyEvent.
		835
		836	=item L<Event::ExecFlow>
		837
		838	High level API for event-based execution flow control.
		839
		840	=item L<Coro>
		841
		842	Has special support for AnyEvent via L<Coro::AnyEvent>.
		843
		844	=item L<IO::Lambda>
		845
		846	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
		847
		848	=back
231		849
232	=cut	850	=cut
233		851
234	package AnyEvent;	852	package AnyEvent;
235		853
236	no warnings;	854	no warnings;
237	use strict;	855	use strict;
		856
238	use Carp;	857	use Carp;
239		858
240	our $VERSION = '2.5';	859	our $VERSION = 4.231;
241	our $MODEL;	860	our $MODEL;
242		861
243	our $AUTOLOAD;	862	our $AUTOLOAD;
244	our @ISA;	863	our @ISA;
245		864
		865	our @REGISTRY;
		866
		867	our $WIN32;
		868
		869	BEGIN {
		870	my $win32 = ! ! ($^O =~ /mswin32/i);
		871	eval "sub WIN32(){ $win32 }";
		872	}
		873
246	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	874	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
247		875
248	our @REGISTRY;	876	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
		877
		878	{
		879	my $idx;
		880	$PROTOCOL{$_} = ++$idx
		881	for reverse split /\s*,\s*/,
		882	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
		883	}
249		884
250	my @models = (	885	my @models = (
251	[Coro::Event:: => AnyEvent::Impl::Coro::],	886	[EV:: => AnyEvent::Impl::EV::],
252	[Event:: => AnyEvent::Impl::Event::],	887	[Event:: => AnyEvent::Impl::Event::],
253	[Glib:: => AnyEvent::Impl::Glib::],
254	[Tk:: => AnyEvent::Impl::Tk::],
255	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	888	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
		889	# everything below here will not be autoprobed
		890	# as the pureperl backend should work everywhere
		891	# and is usually faster
		892	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		893	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		894	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		895	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
		896	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
		897	[Wx:: => AnyEvent::Impl::POE::],
		898	[Prima:: => AnyEvent::Impl::POE::],
256	);	899	);
257		900
258	our %method = map +($_ => 1), qw(io timer condvar broadcast wait signal one_event DESTROY);	901	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
		902
		903	our @post_detect;
		904
		905	sub post_detect(&) {
		906	my ($cb) = @_;
		907
		908	if ($MODEL) {
		909	$cb->();
		910
		911	1
		912	} else {
		913	push @post_detect, $cb;
		914
		915	defined wantarray
		916	? bless \$cb, "AnyEvent::Util::PostDetect"
		917	: ()
		918	}
		919	}
		920
		921	sub AnyEvent::Util::PostDetect::DESTROY {
		922	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		923	}
259		924
260	sub detect() {	925	sub detect() {
261	unless ($MODEL) {	926	unless ($MODEL) {
262	no strict 'refs';	927	no strict 'refs';
		928	local $SIG{__DIE__};
		929
		930	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		931	my $model = "AnyEvent::Impl::$1";
		932	if (eval "require $model") {
		933	$MODEL = $model;
		934	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;
		935	} else {
		936	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;
		937	}
		938	}
263		939
264	# check for already loaded models	940	# check for already loaded models
		941	unless ($MODEL) {
265	for (@REGISTRY, @models) {	942	for (@REGISTRY, @models) {
266	my ($package, $model) = @$_;	943	my ($package, $model) = @$_;
267	if (${"$package\::VERSION"} > 0) {	944	if (${"$package\::VERSION"} > 0) {
268	if (eval "require $model") {	945	if (eval "require $model") {
269	$MODEL = $model;	946	$MODEL = $model;
270	warn "AnyEvent: found model '$model', using it.\n" if $verbose > 1;	947	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;
271	last;	948	last;
		949	}
272	}	950	}
273	}	951	}
		952
		953	unless ($MODEL) {
		954	# try to load a model
		955
		956	for (@REGISTRY, @models) {
		957	my ($package, $model) = @$_;
		958	if (eval "require $package"
		959	and ${"$package\::VERSION"} > 0
		960	and eval "require $model") {
		961	$MODEL = $model;
		962	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
		963	last;
		964	}
		965	}
		966
		967	$MODEL
		968	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
		969	}
274	}	970	}
275		971
276	unless ($MODEL) {	972	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
277	# try to load a model
278
279	for (@REGISTRY, @models) {
280	my ($package, $model) = @$_;
281	if (eval "require $model") {
282	$MODEL = $model;
283	warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1;
284	last;
285	}
286	}
287
288	$MODEL
289	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: Event (or Coro+Event), Glib or Tk.";
290	}
291		973
292	unshift @ISA, $MODEL;	974	unshift @ISA, $MODEL;
293	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	975
		976	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		977
		978	(shift @post_detect)->() while @post_detect;
294	}	979	}
295		980
296	$MODEL	981	$MODEL
297	}	982	}
298		983
…		…
306		991
307	my $class = shift;	992	my $class = shift;
308	$class->$func (@_);	993	$class->$func (@_);
309	}	994	}
310		995
		996	# utility function to dup a filehandle. this is used by many backends
		997	# to support binding more than one watcher per filehandle (they usually
		998	# allow only one watcher per fd, so we dup it to get a different one).
		999	sub _dupfh($$$$) {
		1000	my ($poll, $fh, $r, $w) = @_;
		1001
		1002	require Fcntl;
		1003
		1004	# cygwin requires the fh mode to be matching, unix doesn't
		1005	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
		1006	: $poll eq "w" ? ($w, ">")
		1007	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
		1008
		1009	open my $fh2, "$mode&" . fileno $fh
		1010	or die "cannot dup() filehandle: $!";
		1011
		1012	# we assume CLOEXEC is already set by perl in all important cases
		1013
		1014	($fh2, $rw)
		1015	}
		1016
311	package AnyEvent::Base;	1017	package AnyEvent::Base;
312		1018
		1019	# default implementation for now and time
		1020
		1021	use Time::HiRes ();
		1022
		1023	sub time { Time::HiRes::time }
		1024	sub now { Time::HiRes::time }
		1025
		1026	# default implementation for ->condvar
		1027
		1028	sub condvar {
		1029	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
		1030	}
		1031
313	# default implementation for signal	1032	# default implementation for ->signal
314		1033
315	our %SIG_CB;	1034	our %SIG_CB;
316		1035
317	sub signal {	1036	sub signal {
318	my (undef, %arg) = @_;	1037	my (undef, %arg) = @_;
319		1038
320	my $signal = uc $arg{signal}	1039	my $signal = uc $arg{signal}
321	or Carp::croak "required option 'signal' is missing";	1040	or Carp::croak "required option 'signal' is missing";
322		1041
323	my $w = bless [$signal, $arg{cb}], "AnyEvent::Base::Signal";
324
325	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1042	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
326	$SIG{$signal} ||= sub {	1043	$SIG{$signal} ||= sub {
327	$_->() for values %{ $SIG_CB{$signal} };	1044	$_->() for values %{ $SIG_CB{$signal} || {} };
328	};	1045	};
329		1046
330	$w	1047	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
331	}	1048	}
332		1049
333	sub AnyEvent::Base::Signal::DESTROY {	1050	sub AnyEvent::Base::Signal::DESTROY {
334	my ($signal, $cb) = @{$_[0]};	1051	my ($signal, $cb) = @{$_[0]};
335		1052
336	delete $SIG_CB{$signal}{$cb};	1053	delete $SIG_CB{$signal}{$cb};
337		1054
338	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };	1055	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
339	}	1056	}
		1057
		1058	# default implementation for ->child
		1059
		1060	our %PID_CB;
		1061	our $CHLD_W;
		1062	our $CHLD_DELAY_W;
		1063	our $PID_IDLE;
		1064	our $WNOHANG;
		1065
		1066	sub _child_wait {
		1067	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
		1068	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
		1069	(values %{ $PID_CB{0} || {} });
		1070	}
		1071
		1072	undef $PID_IDLE;
		1073	}
		1074
		1075	sub _sigchld {
		1076	# make sure we deliver these changes "synchronous" with the event loop.
		1077	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
		1078	undef $CHLD_DELAY_W;
		1079	&_child_wait;
		1080	});
		1081	}
		1082
		1083	sub child {
		1084	my (undef, %arg) = @_;
		1085
		1086	defined (my $pid = $arg{pid} + 0)
		1087	or Carp::croak "required option 'pid' is missing";
		1088
		1089	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
		1090
		1091	unless ($WNOHANG) {
		1092	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
		1093	}
		1094
		1095	unless ($CHLD_W) {
		1096	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
		1097	# child could be a zombie already, so make at least one round
		1098	&_sigchld;
		1099	}
		1100
		1101	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"
		1102	}
		1103
		1104	sub AnyEvent::Base::Child::DESTROY {
		1105	my ($pid, $cb) = @{$_[0]};
		1106
		1107	delete $PID_CB{$pid}{$cb};
		1108	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
		1109
		1110	undef $CHLD_W unless keys %PID_CB;
		1111	}
		1112
		1113	package AnyEvent::CondVar;
		1114
		1115	our @ISA = AnyEvent::CondVar::Base::;
		1116
		1117	package AnyEvent::CondVar::Base;
		1118
		1119	use overload
		1120	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		1121	fallback => 1;
		1122
		1123	sub _send {
		1124	# nop
		1125	}
		1126
		1127	sub send {
		1128	my $cv = shift;
		1129	$cv->{_ae_sent} = [@_];
		1130	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
		1131	$cv->_send;
		1132	}
		1133
		1134	sub croak {
		1135	$_[0]{_ae_croak} = $_[1];
		1136	$_[0]->send;
		1137	}
		1138
		1139	sub ready {
		1140	$_[0]{_ae_sent}
		1141	}
		1142
		1143	sub _wait {
		1144	AnyEvent->one_event while !$_[0]{_ae_sent};
		1145	}
		1146
		1147	sub recv {
		1148	$_[0]->_wait;
		1149
		1150	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
		1151	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
		1152	}
		1153
		1154	sub cb {
		1155	$_[0]{_ae_cb} = $_[1] if @_ > 1;
		1156	$_[0]{_ae_cb}
		1157	}
		1158
		1159	sub begin {
		1160	++$_[0]{_ae_counter};
		1161	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
		1162	}
		1163
		1164	sub end {
		1165	return if --$_[0]{_ae_counter};
		1166	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
		1167	}
		1168
		1169	# undocumented/compatibility with pre-3.4
		1170	*broadcast = \&send;
		1171	*wait = \&_wait;
340		1172
341	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1173	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
		1174
		1175	This is an advanced topic that you do not normally need to use AnyEvent in
		1176	a module. This section is only of use to event loop authors who want to
		1177	provide AnyEvent compatibility.
342		1178
343	If you need to support another event library which isn't directly	1179	If you need to support another event library which isn't directly
344	supported by AnyEvent, you can supply your own interface to it by	1180	supported by AnyEvent, you can supply your own interface to it by
345	pushing, before the first watcher gets created, the package name of	1181	pushing, before the first watcher gets created, the package name of
346	the event module and the package name of the interface to use onto	1182	the event module and the package name of the interface to use onto
347	C<@AnyEvent::REGISTRY>. You can do that before and even without loading	1183	C<@AnyEvent::REGISTRY>. You can do that before and even without loading
348	AnyEvent.	1184	AnyEvent, so it is reasonably cheap.
349		1185
350	Example:	1186	Example:
351		1187
352	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1188	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
353		1189
354	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>	1190	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>
355	package/class when it finds the C<urxvt> package/module is loaded. When	1191	package/class when it finds the C<urxvt> package/module is already loaded.
		1192
356	AnyEvent is loaded and asked to find a suitable event model, it will	1193	When AnyEvent is loaded and asked to find a suitable event model, it
357	first check for the presence of urxvt.	1194	will first check for the presence of urxvt by trying to C<use> the
		1195	C<urxvt::anyevent> module.
358		1196
359	The class should provide implementations for all watcher types (see	1197	The class should provide implementations for all watcher types. See
360	L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib>	1198	L<AnyEvent::Impl::EV> (source code), L<AnyEvent::Impl::Glib> (Source code)
361	(Source code) and so on for actual examples, use C<perldoc -m	1199	and so on for actual examples. Use C<perldoc -m AnyEvent::Impl::Glib> to
362	AnyEvent::Impl::Glib> to see the sources).	1200	see the sources.
363		1201
		1202	If you don't provide C<signal> and C<child> watchers than AnyEvent will
		1203	provide suitable (hopefully) replacements.
		1204
364	The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)	1205	The above example isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)
365	uses the above line as-is. An interface isn't included in AnyEvent	1206	terminal emulator uses the above line as-is. An interface isn't included
366	because it doesn't make sense outside the embedded interpreter inside	1207	in AnyEvent because it doesn't make sense outside the embedded interpreter
367	I<rxvt-unicode>, and it is updated and maintained as part of the	1208	inside I<rxvt-unicode>, and it is updated and maintained as part of the
368	I<rxvt-unicode> distribution.	1209	I<rxvt-unicode> distribution.
369		1210
370	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1211	I<rxvt-unicode> also cheats a bit by not providing blocking access to
371	condition variables: code blocking while waiting for a condition will	1212	condition variables: code blocking while waiting for a condition will
372	C<die>. This still works with most modules/usages, and blocking calls must	1213	C<die>. This still works with most modules/usages, and blocking calls must
373	not be in an interactive appliation, so it makes sense.	1214	not be done in an interactive application, so it makes sense.
374		1215
375	=head1 ENVIRONMENT VARIABLES	1216	=head1 ENVIRONMENT VARIABLES
376		1217
377	The following environment variables are used by this module:	1218	The following environment variables are used by this module:
378		1219
379	C<PERL_ANYEVENT_VERBOSE> when set to C<2> or higher, reports which event	1220	=over 4
380	model gets used.
381		1221
		1222	=item C<PERL_ANYEVENT_VERBOSE>
		1223
		1224	By default, AnyEvent will be completely silent except in fatal
		1225	conditions. You can set this environment variable to make AnyEvent more
		1226	talkative.
		1227
		1228	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1229	conditions, such as not being able to load the event model specified by
		1230	C<PERL_ANYEVENT_MODEL>.
		1231
		1232	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1233	model it chooses.
		1234
		1235	=item C<PERL_ANYEVENT_STRICT>
		1236
		1237	AnyEvent does not do much argument checking by default, as thorough
		1238	argument checking is very costly. Setting this variable to a true value
		1239	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1240	check the arguments passed to most method calls. If it finds any problems
		1241	it will croak.
		1242
		1243	In other words, enables "strict" mode.
		1244
		1245	Unlike C<use strict> it is definitely recommended ot keep it off in
		1246	production.
		1247
		1248	=item C<PERL_ANYEVENT_MODEL>
		1249
		1250	This can be used to specify the event model to be used by AnyEvent, before
		1251	auto detection and -probing kicks in. It must be a string consisting
		1252	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1253	and the resulting module name is loaded and if the load was successful,
		1254	used as event model. If it fails to load AnyEvent will proceed with
		1255	auto detection and -probing.
		1256
		1257	This functionality might change in future versions.
		1258
		1259	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1260	could start your program like this:
		1261
		1262	PERL_ANYEVENT_MODEL=Perl perl ...
		1263
		1264	=item C<PERL_ANYEVENT_PROTOCOLS>
		1265
		1266	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1267	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1268	of auto probing).
		1269
		1270	Must be set to a comma-separated list of protocols or address families,
		1271	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1272	used, and preference will be given to protocols mentioned earlier in the
		1273	list.
		1274
		1275	This variable can effectively be used for denial-of-service attacks
		1276	against local programs (e.g. when setuid), although the impact is likely
		1277	small, as the program has to handle connection errors already-
		1278
		1279	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1280	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1281	- only support IPv4, never try to resolve or contact IPv6
		1282	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1283	IPv6, but prefer IPv6 over IPv4.
		1284
		1285	=item C<PERL_ANYEVENT_EDNS0>
		1286
		1287	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1288	for DNS. This extension is generally useful to reduce DNS traffic, but
		1289	some (broken) firewalls drop such DNS packets, which is why it is off by
		1290	default.
		1291
		1292	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1293	EDNS0 in its DNS requests.
		1294
		1295	=item C<PERL_ANYEVENT_MAX_FORKS>
		1296
		1297	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1298	will create in parallel.
		1299
		1300	=back
		1301
382	=head1 EXAMPLE	1302	=head1 EXAMPLE PROGRAM
383		1303
384	The following program uses an io watcher to read data from stdin, a timer	1304	The following program uses an I/O watcher to read data from STDIN, a timer
385	to display a message once per second, and a condvar to exit the program	1305	to display a message once per second, and a condition variable to quit the
386	when the user enters quit:	1306	program when the user enters quit:
387		1307
388	use AnyEvent;	1308	use AnyEvent;
389		1309
390	my $cv = AnyEvent->condvar;	1310	my $cv = AnyEvent->condvar;
391		1311
392	my $io_watcher = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	1312	my $io_watcher = AnyEvent->io (
		1313	fh => \*STDIN,
		1314	poll => 'r',
		1315	cb => sub {
393	warn "io event <$_[0]>\n"; # will always output <r>	1316	warn "io event <$_[0]>\n"; # will always output <r>
394	chomp (my $input = <STDIN>); # read a line	1317	chomp (my $input = <STDIN>); # read a line
395	warn "read: $input\n"; # output what has been read	1318	warn "read: $input\n"; # output what has been read
396	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i	1319	$cv->send if $input =~ /^q/i; # quit program if /^q/i
		1320	},
397	});	1321	);
398		1322
399	my $time_watcher; # can only be used once	1323	my $time_watcher; # can only be used once
400		1324
401	sub new_timer {	1325	sub new_timer {
402	$timer = AnyEvent->timer (after => 1, cb => sub {	1326	$timer = AnyEvent->timer (after => 1, cb => sub {
…		…
405	});	1329	});
406	}	1330	}
407		1331
408	new_timer; # create first timer	1332	new_timer; # create first timer
409		1333
410	$cv->wait; # wait until user enters /^q/i	1334	$cv->recv; # wait until user enters /^q/i
411		1335
412	=head1 REAL-WORLD EXAMPLE	1336	=head1 REAL-WORLD EXAMPLE
413		1337
414	Consider the L<Net::FCP> module. It features (among others) the following	1338	Consider the L<Net::FCP> module. It features (among others) the following
415	API calls, which are to freenet what HTTP GET requests are to http:	1339	API calls, which are to freenet what HTTP GET requests are to http:
…		…
465	syswrite $txn->{fh}, $txn->{request}	1389	syswrite $txn->{fh}, $txn->{request}
466	or die "connection or write error";	1390	or die "connection or write error";
467	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	1391	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
468		1392
469	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	1393	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
470	result and signals any possible waiters that the request ahs finished:	1394	result and signals any possible waiters that the request has finished:
471		1395
472	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	1396	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
473		1397
474	if (end-of-file or data complete) {	1398	if (end-of-file or data complete) {
475	$txn->{result} = $txn->{buf};	1399	$txn->{result} = $txn->{buf};
476	$txn->{finished}->broadcast;	1400	$txn->{finished}->send;
477	$txb->{cb}->($txn) of $txn->{cb}; # also call callback	1401	$txb->{cb}->($txn) of $txn->{cb}; # also call callback
478	}	1402	}
479		1403
480	The C<result> method, finally, just waits for the finished signal (if the	1404	The C<result> method, finally, just waits for the finished signal (if the
481	request was already finished, it doesn't wait, of course, and returns the	1405	request was already finished, it doesn't wait, of course, and returns the
482	data:	1406	data:
483		1407
484	$txn->{finished}->wait;	1408	$txn->{finished}->recv;
485	return $txn->{result};	1409	return $txn->{result};
486		1410
487	The actual code goes further and collects all errors (C<die>s, exceptions)	1411	The actual code goes further and collects all errors (C<die>s, exceptions)
488	that occured during request processing. The C<result> method detects	1412	that occurred during request processing. The C<result> method detects
489	wether an exception as thrown (it is stored inside the $txn object)	1413	whether an exception as thrown (it is stored inside the $txn object)
490	and just throws the exception, which means connection errors and other	1414	and just throws the exception, which means connection errors and other
491	problems get reported tot he code that tries to use the result, not in a	1415	problems get reported tot he code that tries to use the result, not in a
492	random callback.	1416	random callback.
493		1417
494	All of this enables the following usage styles:	1418	All of this enables the following usage styles:
495		1419
496	1. Blocking:	1420	1. Blocking:
497		1421
498	my $data = $fcp->client_get ($url);	1422	my $data = $fcp->client_get ($url);
499		1423
500	2. Blocking, but parallelizing:	1424	2. Blocking, but running in parallel:
501		1425
502	my @datas = map $_->result,	1426	my @datas = map $_->result,
503	map $fcp->txn_client_get ($_),	1427	map $fcp->txn_client_get ($_),
504	@urls;	1428	@urls;
505		1429
506	Both blocking examples work without the module user having to know	1430	Both blocking examples work without the module user having to know
507	anything about events.	1431	anything about events.
508		1432
509	3a. Event-based in a main program, using any support Event module:	1433	3a. Event-based in a main program, using any supported event module:
510		1434
511	use Event;	1435	use EV;
512		1436
513	$fcp->txn_client_get ($url)->cb (sub {	1437	$fcp->txn_client_get ($url)->cb (sub {
514	my $txn = shift;	1438	my $txn = shift;
515	my $data = $txn->result;	1439	my $data = $txn->result;
516	...	1440	...
517	});	1441	});
518		1442
519	Event::loop;	1443	EV::loop;
520		1444
521	3b. The module user could use AnyEvent, too:	1445	3b. The module user could use AnyEvent, too:
522		1446
523	use AnyEvent;	1447	use AnyEvent;
524		1448
525	my $quit = AnyEvent->condvar;	1449	my $quit = AnyEvent->condvar;
526		1450
527	$fcp->txn_client_get ($url)->cb (sub {	1451	$fcp->txn_client_get ($url)->cb (sub {
528	...	1452	...
529	$quit->broadcast;	1453	$quit->send;
530	});	1454	});
531		1455
532	$quit->wait;	1456	$quit->recv;
		1457
		1458
		1459	=head1 BENCHMARKS
		1460
		1461	To give you an idea of the performance and overheads that AnyEvent adds
		1462	over the event loops themselves and to give you an impression of the speed
		1463	of various event loops I prepared some benchmarks.
		1464
		1465	=head2 BENCHMARKING ANYEVENT OVERHEAD
		1466
		1467	Here is a benchmark of various supported event models used natively and
		1468	through AnyEvent. The benchmark creates a lot of timers (with a zero
		1469	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
		1470	which it is), lets them fire exactly once and destroys them again.
		1471
		1472	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
		1473	distribution.
		1474
		1475	=head3 Explanation of the columns
		1476
		1477	I<watcher> is the number of event watchers created/destroyed. Since
		1478	different event models feature vastly different performances, each event
		1479	loop was given a number of watchers so that overall runtime is acceptable
		1480	and similar between tested event loop (and keep them from crashing): Glib
		1481	would probably take thousands of years if asked to process the same number
		1482	of watchers as EV in this benchmark.
		1483
		1484	I<bytes> is the number of bytes (as measured by the resident set size,
		1485	RSS) consumed by each watcher. This method of measuring captures both C
		1486	and Perl-based overheads.
		1487
		1488	I<create> is the time, in microseconds (millionths of seconds), that it
		1489	takes to create a single watcher. The callback is a closure shared between
		1490	all watchers, to avoid adding memory overhead. That means closure creation
		1491	and memory usage is not included in the figures.
		1492
		1493	I<invoke> is the time, in microseconds, used to invoke a simple
		1494	callback. The callback simply counts down a Perl variable and after it was
		1495	invoked "watcher" times, it would C<< ->send >> a condvar once to
		1496	signal the end of this phase.
		1497
		1498	I<destroy> is the time, in microseconds, that it takes to destroy a single
		1499	watcher.
		1500
		1501	=head3 Results
		1502
		1503	name watchers bytes create invoke destroy comment
		1504	EV/EV 400000 244 0.56 0.46 0.31 EV native interface
		1505	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers
		1506	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal
		1507	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation
		1508	Event/Event 16000 516 31.88 31.30 0.85 Event native interface
		1509	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers
		1510	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour
		1511	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers
		1512	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event
		1513	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select
		1514
		1515	=head3 Discussion
		1516
		1517	The benchmark does I<not> measure scalability of the event loop very
		1518	well. For example, a select-based event loop (such as the pure perl one)
		1519	can never compete with an event loop that uses epoll when the number of
		1520	file descriptors grows high. In this benchmark, all events become ready at
		1521	the same time, so select/poll-based implementations get an unnatural speed
		1522	boost.
		1523
		1524	Also, note that the number of watchers usually has a nonlinear effect on
		1525	overall speed, that is, creating twice as many watchers doesn't take twice
		1526	the time - usually it takes longer. This puts event loops tested with a
		1527	higher number of watchers at a disadvantage.
		1528
		1529	To put the range of results into perspective, consider that on the
		1530	benchmark machine, handling an event takes roughly 1600 CPU cycles with
		1531	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
		1532	cycles with POE.
		1533
		1534	C<EV> is the sole leader regarding speed and memory use, which are both
		1535	maximal/minimal, respectively. Even when going through AnyEvent, it uses
		1536	far less memory than any other event loop and is still faster than Event
		1537	natively.
		1538
		1539	The pure perl implementation is hit in a few sweet spots (both the
		1540	constant timeout and the use of a single fd hit optimisations in the perl
		1541	interpreter and the backend itself). Nevertheless this shows that it
		1542	adds very little overhead in itself. Like any select-based backend its
		1543	performance becomes really bad with lots of file descriptors (and few of
		1544	them active), of course, but this was not subject of this benchmark.
		1545
		1546	The C<Event> module has a relatively high setup and callback invocation
		1547	cost, but overall scores in on the third place.
		1548
		1549	C<Glib>'s memory usage is quite a bit higher, but it features a
		1550	faster callback invocation and overall ends up in the same class as
		1551	C<Event>. However, Glib scales extremely badly, doubling the number of
		1552	watchers increases the processing time by more than a factor of four,
		1553	making it completely unusable when using larger numbers of watchers
		1554	(note that only a single file descriptor was used in the benchmark, so
		1555	inefficiencies of C<poll> do not account for this).
		1556
		1557	The C<Tk> adaptor works relatively well. The fact that it crashes with
		1558	more than 2000 watchers is a big setback, however, as correctness takes
		1559	precedence over speed. Nevertheless, its performance is surprising, as the
		1560	file descriptor is dup()ed for each watcher. This shows that the dup()
		1561	employed by some adaptors is not a big performance issue (it does incur a
		1562	hidden memory cost inside the kernel which is not reflected in the figures
		1563	above).
		1564
		1565	C<POE>, regardless of underlying event loop (whether using its pure perl
		1566	select-based backend or the Event module, the POE-EV backend couldn't
		1567	be tested because it wasn't working) shows abysmal performance and
		1568	memory usage with AnyEvent: Watchers use almost 30 times as much memory
		1569	as EV watchers, and 10 times as much memory as Event (the high memory
		1570	requirements are caused by requiring a session for each watcher). Watcher
		1571	invocation speed is almost 900 times slower than with AnyEvent's pure perl
		1572	implementation.
		1573
		1574	The design of the POE adaptor class in AnyEvent can not really account
		1575	for the performance issues, though, as session creation overhead is
		1576	small compared to execution of the state machine, which is coded pretty
		1577	optimally within L<AnyEvent::Impl::POE> (and while everybody agrees that
		1578	using multiple sessions is not a good approach, especially regarding
		1579	memory usage, even the author of POE could not come up with a faster
		1580	design).
		1581
		1582	=head3 Summary
		1583
		1584	=over 4
		1585
		1586	=item * Using EV through AnyEvent is faster than any other event loop
		1587	(even when used without AnyEvent), but most event loops have acceptable
		1588	performance with or without AnyEvent.
		1589
		1590	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
		1591	the actual event loop, only with extremely fast event loops such as EV
		1592	adds AnyEvent significant overhead.
		1593
		1594	=item * You should avoid POE like the plague if you want performance or
		1595	reasonable memory usage.
		1596
		1597	=back
		1598
		1599	=head2 BENCHMARKING THE LARGE SERVER CASE
		1600
		1601	This benchmark actually benchmarks the event loop itself. It works by
		1602	creating a number of "servers": each server consists of a socket pair, a
		1603	timeout watcher that gets reset on activity (but never fires), and an I/O
		1604	watcher waiting for input on one side of the socket. Each time the socket
		1605	watcher reads a byte it will write that byte to a random other "server".
		1606
		1607	The effect is that there will be a lot of I/O watchers, only part of which
		1608	are active at any one point (so there is a constant number of active
		1609	fds for each loop iteration, but which fds these are is random). The
		1610	timeout is reset each time something is read because that reflects how
		1611	most timeouts work (and puts extra pressure on the event loops).
		1612
		1613	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
		1614	(1%) are active. This mirrors the activity of large servers with many
		1615	connections, most of which are idle at any one point in time.
		1616
		1617	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
		1618	distribution.
		1619
		1620	=head3 Explanation of the columns
		1621
		1622	I<sockets> is the number of sockets, and twice the number of "servers" (as
		1623	each server has a read and write socket end).
		1624
		1625	I<create> is the time it takes to create a socket pair (which is
		1626	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
		1627
		1628	I<request>, the most important value, is the time it takes to handle a
		1629	single "request", that is, reading the token from the pipe and forwarding
		1630	it to another server. This includes deleting the old timeout and creating
		1631	a new one that moves the timeout into the future.
		1632
		1633	=head3 Results
		1634
		1635	name sockets create request
		1636	EV 20000 69.01 11.16
		1637	Perl 20000 73.32 35.87
		1638	Event 20000 212.62 257.32
		1639	Glib 20000 651.16 1896.30
		1640	POE 20000 349.67 12317.24 uses POE::Loop::Event
		1641
		1642	=head3 Discussion
		1643
		1644	This benchmark I<does> measure scalability and overall performance of the
		1645	particular event loop.
		1646
		1647	EV is again fastest. Since it is using epoll on my system, the setup time
		1648	is relatively high, though.
		1649
		1650	Perl surprisingly comes second. It is much faster than the C-based event
		1651	loops Event and Glib.
		1652
		1653	Event suffers from high setup time as well (look at its code and you will
		1654	understand why). Callback invocation also has a high overhead compared to
		1655	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
		1656	uses select or poll in basically all documented configurations.
		1657
		1658	Glib is hit hard by its quadratic behaviour w.r.t. many watchers. It
		1659	clearly fails to perform with many filehandles or in busy servers.
		1660
		1661	POE is still completely out of the picture, taking over 1000 times as long
		1662	as EV, and over 100 times as long as the Perl implementation, even though
		1663	it uses a C-based event loop in this case.
		1664
		1665	=head3 Summary
		1666
		1667	=over 4
		1668
		1669	=item * The pure perl implementation performs extremely well.
		1670
		1671	=item * Avoid Glib or POE in large projects where performance matters.
		1672
		1673	=back
		1674
		1675	=head2 BENCHMARKING SMALL SERVERS
		1676
		1677	While event loops should scale (and select-based ones do not...) even to
		1678	large servers, most programs we (or I :) actually write have only a few
		1679	I/O watchers.
		1680
		1681	In this benchmark, I use the same benchmark program as in the large server
		1682	case, but it uses only eight "servers", of which three are active at any
		1683	one time. This should reflect performance for a small server relatively
		1684	well.
		1685
		1686	The columns are identical to the previous table.
		1687
		1688	=head3 Results
		1689
		1690	name sockets create request
		1691	EV 16 20.00 6.54
		1692	Perl 16 25.75 12.62
		1693	Event 16 81.27 35.86
		1694	Glib 16 32.63 15.48
		1695	POE 16 261.87 276.28 uses POE::Loop::Event
		1696
		1697	=head3 Discussion
		1698
		1699	The benchmark tries to test the performance of a typical small
		1700	server. While knowing how various event loops perform is interesting, keep
		1701	in mind that their overhead in this case is usually not as important, due
		1702	to the small absolute number of watchers (that is, you need efficiency and
		1703	speed most when you have lots of watchers, not when you only have a few of
		1704	them).
		1705
		1706	EV is again fastest.
		1707
		1708	Perl again comes second. It is noticeably faster than the C-based event
		1709	loops Event and Glib, although the difference is too small to really
		1710	matter.
		1711
		1712	POE also performs much better in this case, but is is still far behind the
		1713	others.
		1714
		1715	=head3 Summary
		1716
		1717	=over 4
		1718
		1719	=item * C-based event loops perform very well with small number of
		1720	watchers, as the management overhead dominates.
		1721
		1722	=back
		1723
		1724
		1725	=head1 FORK
		1726
		1727	Most event libraries are not fork-safe. The ones who are usually are
		1728	because they rely on inefficient but fork-safe C<select> or C<poll>
		1729	calls. Only L<EV> is fully fork-aware.
		1730
		1731	If you have to fork, you must either do so I<before> creating your first
		1732	watcher OR you must not use AnyEvent at all in the child.
		1733
		1734
		1735	=head1 SECURITY CONSIDERATIONS
		1736
		1737	AnyEvent can be forced to load any event model via
		1738	$ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used to
		1739	execute arbitrary code or directly gain access, it can easily be used to
		1740	make the program hang or malfunction in subtle ways, as AnyEvent watchers
		1741	will not be active when the program uses a different event model than
		1742	specified in the variable.
		1743
		1744	You can make AnyEvent completely ignore this variable by deleting it
		1745	before the first watcher gets created, e.g. with a C<BEGIN> block:
		1746
		1747	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
		1748
		1749	use AnyEvent;
		1750
		1751	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
		1752	be used to probe what backend is used and gain other information (which is
		1753	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		1754	$ENV{PERL_ANYEGENT_STRICT}.
		1755
		1756
		1757	=head1 BUGS
		1758
		1759	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		1760	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		1761	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		1762	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
		1763	pronounced).
		1764
533		1765
534	=head1 SEE ALSO	1766	=head1 SEE ALSO
535		1767
536	Event modules: L<Coro::Event>, L<Coro>, L<Event>, L<Glib::Event>, L<Glib>.	1768	Utility functions: L<AnyEvent::Util>.
537		1769
538	Implementations: L<AnyEvent::Impl::Coro>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>.	1770	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
		1771	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
539		1772
540	Nontrivial usage example: L<Net::FCP>.	1773	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
		1774	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
		1775	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
		1776	L<AnyEvent::Impl::POE>.
541		1777
542	=head1	1778	Non-blocking file handles, sockets, TCP clients and
		1779	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
		1780
		1781	Asynchronous DNS: L<AnyEvent::DNS>.
		1782
		1783	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
		1784
		1785	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
		1786
		1787
		1788	=head1 AUTHOR
		1789
		1790	Marc Lehmann <schmorp@schmorp.de>
		1791	http://home.schmorp.de/
543		1792
544	=cut	1793	=cut
545		1794
546	1	1795	1
547		1796

Diff Legend

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