ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.100 by elmex, Sun Apr 27 19:15:43 2008 UTC vs.
Revision 1.195 by root, Wed Mar 25 17:33:11 2009 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	EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt, POE - 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 whether 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.
22		37
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	38	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		39
25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	40	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26	nowadays. So what is different about AnyEvent?	41	nowadays. So what is different about AnyEvent?
27		42
28	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	43	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29	policy> and AnyEvent is I<small and efficient>.	44	policy> and AnyEvent is I<small and efficient>.
30		45
31	First and foremost, I<AnyEvent is not an event model> itself, it only	46	First and foremost, I<AnyEvent is not an event model> itself, it only
32	interfaces to whatever event model the main program happens to use in a	47	interfaces to whatever event model the main program happens to use, in a
33	pragmatic way. For event models and certain classes of immortals alike,	48	pragmatic way. For event models and certain classes of immortals alike,
34	the statement "there can only be one" is a bitter reality: In general,	49	the statement "there can only be one" is a bitter reality: In general,
35	only one event loop can be active at the same time in a process. AnyEvent	50	only one event loop can be active at the same time in a process. AnyEvent
36	helps hiding the differences between those event loops.	51	cannot change this, but it can hide the differences between those event
		52	loops.
37		53
38	The goal of AnyEvent is to offer module authors the ability to do event	54	The goal of AnyEvent is to offer module authors the ability to do event
39	programming (waiting for I/O or timer events) without subscribing to a	55	programming (waiting for I/O or timer events) without subscribing to a
40	religion, a way of living, and most importantly: without forcing your	56	religion, a way of living, and most importantly: without forcing your
41	module users into the same thing by forcing them to use the same event	57	module users into the same thing by forcing them to use the same event
42	model you use.	58	model you use.
43		59
44	For modules like POE or IO::Async (which is a total misnomer as it is	60	For modules like POE or IO::Async (which is a total misnomer as it is
45	actually doing all I/O I<synchronously>...), using them in your module is	61	actually doing all I/O I<synchronously>...), using them in your module is
46	like joining a cult: After you joined, you are dependent on them and you	62	like joining a cult: After you joined, you are dependent on them and you
47	cannot use anything else, as it is simply incompatible to everything that	63	cannot use anything else, as they are simply incompatible to everything
48	isn't itself. What's worse, all the potential users of your module are	64	that isn't them. What's worse, all the potential users of your
49	I<also> forced to use the same event loop you use.	65	module are I<also> forced to use the same event loop you use.
50		66
51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	67	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	68	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
53	with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if	69	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
54	your module uses one of those, every user of your module has to use it,	70	your module uses one of those, every user of your module has to use it,
55	too. But if your module uses AnyEvent, it works transparently with all	71	too. But if your module uses AnyEvent, it works transparently with all
56	event models it supports (including stuff like POE and IO::Async, as long	72	event models it supports (including stuff like IO::Async, as long as those
57	as those use one of the supported event loops. It is trivial to add new	73	use one of the supported event loops. It is trivial to add new event loops
58	event loops to AnyEvent, too, so it is future-proof).	74	to AnyEvent, too, so it is future-proof).
59		75
60	In addition to being free of having to use I<the one and only true event	76	In addition to being free of having to use I<the one and only true event
61	model>, AnyEvent also is free of bloat and policy: with POE or similar	77	model>, AnyEvent also is free of bloat and policy: with POE or similar
62	modules, you get an enourmous amount of code and strict rules you have to	78	modules, you get an enormous amount of code and strict rules you have to
63	follow. AnyEvent, on the other hand, is lean and up to the point, by only	79	follow. AnyEvent, on the other hand, is lean and up to the point, by only
64	offering the functionality that is necessary, in as thin as a wrapper as	80	offering the functionality that is necessary, in as thin as a wrapper as
65	technically possible.	81	technically possible.
66		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
67	Of course, if you want lots of policy (this can arguably be somewhat	89	Now, if you I<do want> lots of policy (this can arguably be somewhat
68	useful) and you want to force your users to use the one and only event	90	useful) and you want to force your users to use the one and only event
69	model, you should I<not> use this module.	91	model, you should I<not> use this module.
70
71	#TODO#
72
73	Net::IRC3
74	AnyEvent::HTTPD
75	AnyEvent::DNS
76	IO::AnyEvent
77	Net::FPing
78	Net::XMPP2
79	Coro
80
81	AnyEvent::IRC
82	AnyEvent::HTTPD
83	AnyEvent::DNS
84	AnyEvent::Handle
85	AnyEvent::Socket
86	AnyEvent::FPing
87	AnyEvent::XMPP
88	AnyEvent::SNMP
89	Coro
90		92
91	=head1 DESCRIPTION	93	=head1 DESCRIPTION
92		94
93	L<AnyEvent> provides an identical interface to multiple event loops. This	95	L<AnyEvent> provides an identical interface to multiple event loops. This
94	allows module authors to utilise an event loop without forcing module	96	allows module authors to utilise an event loop without forcing module
…		…
98	The interface itself is vaguely similar, but not identical to the L<Event>	100	The interface itself is vaguely similar, but not identical to the L<Event>
99	module.	101	module.
100		102
101	During the first call of any watcher-creation method, the module tries	103	During the first call of any watcher-creation method, the module tries
102	to detect the currently loaded event loop by probing whether one of the	104	to detect the currently loaded event loop by probing whether one of the
103	following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>,	105	following modules is already loaded: L<EV>,
104	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	106	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,
105	L<POE>. The first one found is used. If none are found, the module tries	107	L<POE>. The first one found is used. If none are found, the module tries
106	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	108	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl
107	adaptor should always succeed) in the order given. The first one that can	109	adaptor should always succeed) in the order given. The first one that can
108	be successfully loaded will be used. If, after this, still none could be	110	be successfully loaded will be used. If, after this, still none could be
…		…
122	starts using it, all bets are off. Maybe you should tell their authors to	124	starts using it, all bets are off. Maybe you should tell their authors to
123	use AnyEvent so their modules work together with others seamlessly...	125	use AnyEvent so their modules work together with others seamlessly...
124		126
125	The pure-perl implementation of AnyEvent is called	127	The pure-perl implementation of AnyEvent is called
126	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
127	explicitly.	129	explicitly and enjoy the high availability of that event loop :)
128		130
129	=head1 WATCHERS	131	=head1 WATCHERS
130		132
131	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
132	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
133	the callback to call, the filehandle to watch, etc.	135	the callback to call, the file handle to watch, etc.
134		136
135	These watchers are normal Perl objects with normal Perl lifetime. After	137	These watchers are normal Perl objects with normal Perl lifetime. After
136	creating a watcher it will immediately "watch" for events and invoke the	138	creating a watcher it will immediately "watch" for events and invoke the
137	callback when the event occurs (of course, only when the event model	139	callback when the event occurs (of course, only when the event model
138	is in control).	140	is in control).
…		…
146	Many watchers either are used with "recursion" (repeating timers for	148	Many watchers either are used with "recursion" (repeating timers for
147	example), or need to refer to their watcher object in other ways.	149	example), or need to refer to their watcher object in other ways.
148		150
149	An any way to achieve that is this pattern:	151	An any way to achieve that is this pattern:
150		152
151	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	153	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
152	# you can use $w here, for example to undef it	154	# you can use $w here, for example to undef it
153	undef $w;	155	undef $w;
154	});	156	});
155		157
156	Note that C<my $w; $w => combination. This is necessary because in Perl,	158	Note that C<my $w; $w => combination. This is necessary because in Perl,
157	my variables are only visible after the statement in which they are	159	my variables are only visible after the statement in which they are
158	declared.	160	declared.
159		161
160	=head2 I/O WATCHERS	162	=head2 I/O WATCHERS
161		163
162	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	164	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
163	with the following mandatory key-value pairs as arguments:	165	with the following mandatory key-value pairs as arguments:
164		166
165	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	167	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events
166	for events. C<poll> must be a string that is either C<r> or C<w>,	168	(AnyEvent might or might not keep a reference to this file handle). C<poll>
167	which creates a watcher waiting for "r"eadable or "w"ritable events,	169	must be a string that is either C<r> or C<w>, which creates a watcher
168	respectively. C<cb> is the callback to invoke each time the file handle	170	waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
169	becomes ready.	171	callback to invoke each time the file handle becomes ready.
170		172
171	Although the callback might get passed parameters, their value and	173	Although the callback might get passed parameters, their value and
172	presence is undefined and you cannot rely on them. Portable AnyEvent	174	presence is undefined and you cannot rely on them. Portable AnyEvent
173	callbacks cannot use arguments passed to I/O watcher callbacks.	175	callbacks cannot use arguments passed to I/O watcher callbacks.
174		176
…		…
178		180
179	Some event loops issue spurious readyness notifications, so you should	181	Some event loops issue spurious readyness notifications, so you should
180	always use non-blocking calls when reading/writing from/to your file	182	always use non-blocking calls when reading/writing from/to your file
181	handles.	183	handles.
182		184
183	Example:
184
185	# 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
186	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	188	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
187	chomp (my $input = <STDIN>);	189	chomp (my $input = <STDIN>);
188	warn "read: $input\n";	190	warn "read: $input\n";
189	undef $w;	191	undef $w;
190	});	192	});
…		…
200		202
201	Although the callback might get passed parameters, their value and	203	Although the callback might get passed parameters, their value and
202	presence is undefined and you cannot rely on them. Portable AnyEvent	204	presence is undefined and you cannot rely on them. Portable AnyEvent
203	callbacks cannot use arguments passed to time watcher callbacks.	205	callbacks cannot use arguments passed to time watcher callbacks.
204		206
205	The timer callback will be invoked at most once: if you want a repeating	207	The callback will normally be invoked once only. If you specify another
206	timer you have to create a new watcher (this is a limitation by both Tk	208	parameter, C<interval>, as a strictly positive number (> 0), then the
207	and Glib).	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.
208		212
209	Example:	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.
210		216
211	# fire an event after 7.7 seconds	217	Example: fire an event after 7.7 seconds.
		218
212	my $w = AnyEvent->timer (after => 7.7, cb => sub {	219	my $w = AnyEvent->timer (after => 7.7, cb => sub {
213	warn "timeout\n";	220	warn "timeout\n";
214	});	221	});
215		222
216	# to cancel the timer:	223	# to cancel the timer:
217	undef $w;	224	undef $w;
218		225
219	Example 2:
220
221	# fire an event after 0.5 seconds, then roughly every second	226	Example 2: fire an event after 0.5 seconds, then roughly every second.
222	my $w;
223		227
224	my $cb = sub {
225	# cancel the old timer while creating a new one
226	$w = AnyEvent->timer (after => 1, cb => $cb);	228	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		229	warn "timeout\n";
227	};	230	};
228
229	# start the "loop" by creating the first watcher
230	$w = AnyEvent->timer (after => 0.5, cb => $cb);
231		231
232	=head3 TIMING ISSUES	232	=head3 TIMING ISSUES
233		233
234	There are two ways to handle timers: based on real time (relative, "fire	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	235	in 10 seconds") and based on wallclock time (absolute, "fire at 12
…		…
247	timers.	247	timers.
248		248
249	AnyEvent always prefers relative timers, if available, matching the	249	AnyEvent always prefers relative timers, if available, matching the
250	AnyEvent API.	250	AnyEvent API.
251		251
		252	AnyEvent has two additional methods that return the "current time":
		253
		254	=over 4
		255
		256	=item AnyEvent->time
		257
		258	This returns the "current wallclock time" as a fractional number of
		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).
		261
		262	It progresses independently of any event loop processing, i.e. each call
		263	will check the system clock, which usually gets updated frequently.
		264
		265	=item AnyEvent->now
		266
		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.
		271
		272	I<In almost all cases (in all cases if you don't care), this is the
		273	function to call when you want to know the current time.>
		274
		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
252	=head2 SIGNAL WATCHERS	315	=head2 SIGNAL WATCHERS
253		316
254	You can watch for signals using a signal watcher, C<signal> is the signal	317	You can watch for signals using a signal watcher, C<signal> is the signal
255	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	318	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
256	be invoked whenever a signal occurs.	319	callback to be invoked whenever a signal occurs.
257		320
258	Although the callback might get passed parameters, their value and	321	Although the callback might get passed parameters, their value and
259	presence is undefined and you cannot rely on them. Portable AnyEvent	322	presence is undefined and you cannot rely on them. Portable AnyEvent
260	callbacks cannot use arguments passed to signal watcher callbacks.	323	callbacks cannot use arguments passed to signal watcher callbacks.
261		324
262	Multiple signal occurances can be clumped together into one callback	325	Multiple signal occurrences can be clumped together into one callback
263	invocation, and callback invocation will be synchronous. synchronous means	326	invocation, and callback invocation will be synchronous. Synchronous means
264	that it might take a while until the signal gets handled by the process,	327	that it might take a while until the signal gets handled by the process,
265	but it is guarenteed not to interrupt any other callbacks.	328	but it is guaranteed not to interrupt any other callbacks.
266		329
267	The main advantage of using these watchers is that you can share a signal	330	The main advantage of using these watchers is that you can share a signal
268	between multiple watchers.	331	between multiple watchers.
269		332
270	This watcher might use C<%SIG>, so programs overwriting those signals	333	This watcher might use C<%SIG>, so programs overwriting those signals
…		…
277	=head2 CHILD PROCESS WATCHERS	340	=head2 CHILD PROCESS WATCHERS
278		341
279	You can also watch on a child process exit and catch its exit status.	342	You can also watch on a child process exit and catch its exit status.
280		343
281	The child process is specified by the C<pid> argument (if set to C<0>, it	344	The child process is specified by the C<pid> argument (if set to C<0>, it
282	watches for any child process exit). The watcher will trigger as often	345	watches for any child process exit). The watcher will triggered only when
283	as status change for the child are received. This works by installing a	346	the child process has finished and an exit status is available, not on
284	signal handler for C<SIGCHLD>. The callback will be called with the pid	347	any trace events (stopped/continued).
285	and exit status (as returned by waitpid), so unlike other watcher types,	348
286	you I<can> rely on child watcher callback arguments.	349	The callback will be called with the pid and exit status (as returned by
		350	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		351	callback arguments.
		352
		353	This watcher type works by installing a signal handler for C<SIGCHLD>,
		354	and since it cannot be shared, nothing else should use SIGCHLD or reap
		355	random child processes (waiting for specific child processes, e.g. inside
		356	C<system>, is just fine).
287		357
288	There is a slight catch to child watchers, however: you usually start them	358	There is a slight catch to child watchers, however: you usually start them
289	I<after> the child process was created, and this means the process could	359	I<after> the child process was created, and this means the process could
290	have exited already (and no SIGCHLD will be sent anymore).	360	have exited already (and no SIGCHLD will be sent anymore).
291		361
…		…
297	AnyEvent program, you I<have> to create at least one watcher before you	367	AnyEvent program, you I<have> to create at least one watcher before you
298	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	368	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
299		369
300	Example: fork a process and wait for it	370	Example: fork a process and wait for it
301		371
302	my $done = AnyEvent->condvar;	372	my $done = AnyEvent->condvar;
303		373
304	AnyEvent::detect; # force event module to be initialised
305
306	my $pid = fork or exit 5;	374	my $pid = fork or exit 5;
307		375
308	my $w = AnyEvent->child (	376	my $w = AnyEvent->child (
309	pid => $pid,	377	pid => $pid,
310	cb => sub {	378	cb => sub {
311	my ($pid, $status) = @_;	379	my ($pid, $status) = @_;
312	warn "pid $pid exited with status $status";	380	warn "pid $pid exited with status $status";
313	$done->broadcast;	381	$done->send;
314	},	382	},
315	);	383	);
316		384
317	# do something else, then wait for process exit	385	# do something else, then wait for process exit
318	$done->wait;	386	$done->recv;
319		387
320	=head2 CONDITION VARIABLES	388	=head2 CONDITION VARIABLES
321		389
		390	If you are familiar with some event loops you will know that all of them
		391	require you to run some blocking "loop", "run" or similar function that
		392	will actively watch for new events and call your callbacks.
		393
		394	AnyEvent is different, it expects somebody else to run the event loop and
		395	will only block when necessary (usually when told by the user).
		396
		397	The instrument to do that is called a "condition variable", so called
		398	because they represent a condition that must become true.
		399
322	Condition variables can be created by calling the C<< AnyEvent->condvar >>	400	Condition variables can be created by calling the C<< AnyEvent->condvar
323	method without any arguments.	401	>> method, usually without arguments. The only argument pair allowed is
324		402
325	A condition variable waits for a condition - precisely that the C<<	403	C<cb>, which specifies a callback to be called when the condition variable
326	->broadcast >> method has been called.	404	becomes true, with the condition variable as the first argument (but not
		405	the results).
327		406
328	They are very useful to signal that a condition has been fulfilled, for	407	After creation, the condition variable is "false" until it becomes "true"
		408	by calling the C<send> method (or calling the condition variable as if it
		409	were a callback, read about the caveats in the description for the C<<
		410	->send >> method).
		411
		412	Condition variables are similar to callbacks, except that you can
		413	optionally wait for them. They can also be called merge points - points
		414	in time where multiple outstanding events have been processed. And yet
		415	another way to call them is transactions - each condition variable can be
		416	used to represent a transaction, which finishes at some point and delivers
		417	a result.
		418
		419	Condition variables are very useful to signal that something has finished,
329	example, if you write a module that does asynchronous http requests,	420	for example, if you write a module that does asynchronous http requests,
330	then a condition variable would be the ideal candidate to signal the	421	then a condition variable would be the ideal candidate to signal the
331	availability of results.	422	availability of results. The user can either act when the callback is
		423	called or can synchronously C<< ->recv >> for the results.
332		424
333	You can also use condition variables to block your main program until	425	You can also use them to simulate traditional event loops - for example,
334	an event occurs - for example, you could C<< ->wait >> in your main	426	you can block your main program until an event occurs - for example, you
335	program until the user clicks the Quit button in your app, which would C<<	427	could C<< ->recv >> in your main program until the user clicks the Quit
336	->broadcast >> the "quit" event.	428	button of your app, which would C<< ->send >> the "quit" event.
337		429
338	Note that condition variables recurse into the event loop - if you have	430	Note that condition variables recurse into the event loop - if you have
339	two pirces of code that call C<< ->wait >> in a round-robbin fashion, you	431	two pieces of code that call C<< ->recv >> in a round-robin fashion, you
340	lose. Therefore, condition variables are good to export to your caller, but	432	lose. Therefore, condition variables are good to export to your caller, but
341	you should avoid making a blocking wait yourself, at least in callbacks,	433	you should avoid making a blocking wait yourself, at least in callbacks,
342	as this asks for trouble.	434	as this asks for trouble.
343		435
344	This object has two methods:	436	Condition variables are represented by hash refs in perl, and the keys
		437	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
		438	easy (it is often useful to build your own transaction class on top of
		439	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
		440	it's C<new> method in your own C<new> method.
		441
		442	There are two "sides" to a condition variable - the "producer side" which
		443	eventually calls C<< -> send >>, and the "consumer side", which waits
		444	for the send to occur.
		445
		446	Example: wait for a timer.
		447
		448	# wait till the result is ready
		449	my $result_ready = AnyEvent->condvar;
		450
		451	# do something such as adding a timer
		452	# or socket watcher the calls $result_ready->send
		453	# when the "result" is ready.
		454	# in this case, we simply use a timer:
		455	my $w = AnyEvent->timer (
		456	after => 1,
		457	cb => sub { $result_ready->send },
		458	);
		459
		460	# this "blocks" (while handling events) till the callback
		461	# calls send
		462	$result_ready->recv;
		463
		464	Example: wait for a timer, but take advantage of the fact that
		465	condition variables are also code references.
		466
		467	my $done = AnyEvent->condvar;
		468	my $delay = AnyEvent->timer (after => 5, cb => $done);
		469	$done->recv;
		470
		471	Example: Imagine an API that returns a condvar and doesn't support
		472	callbacks. This is how you make a synchronous call, for example from
		473	the main program:
		474
		475	use AnyEvent::CouchDB;
		476
		477	...
		478
		479	my @info = $couchdb->info->recv;
		480
		481	And this is how you would just ste a callback to be called whenever the
		482	results are available:
		483
		484	$couchdb->info->cb (sub {
		485	my @info = $_[0]->recv;
		486	});
		487
		488	=head3 METHODS FOR PRODUCERS
		489
		490	These methods should only be used by the producing side, i.e. the
		491	code/module that eventually sends the signal. Note that it is also
		492	the producer side which creates the condvar in most cases, but it isn't
		493	uncommon for the consumer to create it as well.
345		494
346	=over 4	495	=over 4
347		496
		497	=item $cv->send (...)
		498
		499	Flag the condition as ready - a running C<< ->recv >> and all further
		500	calls to C<recv> will (eventually) return after this method has been
		501	called. If nobody is waiting the send will be remembered.
		502
		503	If a callback has been set on the condition variable, it is called
		504	immediately from within send.
		505
		506	Any arguments passed to the C<send> call will be returned by all
		507	future C<< ->recv >> calls.
		508
		509	Condition variables are overloaded so one can call them directly
		510	(as a code reference). Calling them directly is the same as calling
		511	C<send>. Note, however, that many C-based event loops do not handle
		512	overloading, so as tempting as it may be, passing a condition variable
		513	instead of a callback does not work. Both the pure perl and EV loops
		514	support overloading, however, as well as all functions that use perl to
		515	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
		516	example).
		517
		518	=item $cv->croak ($error)
		519
		520	Similar to send, but causes all call's to C<< ->recv >> to invoke
		521	C<Carp::croak> with the given error message/object/scalar.
		522
		523	This can be used to signal any errors to the condition variable
		524	user/consumer.
		525
		526	=item $cv->begin ([group callback])
		527
348	=item $cv->wait	528	=item $cv->end
349		529
350	Wait (blocking if necessary) until the C<< ->broadcast >> method has been	530	These two methods are EXPERIMENTAL and MIGHT CHANGE.
		531
		532	These two methods can be used to combine many transactions/events into
		533	one. For example, a function that pings many hosts in parallel might want
		534	to use a condition variable for the whole process.
		535
		536	Every call to C<< ->begin >> will increment a counter, and every call to
		537	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
		538	>>, the (last) callback passed to C<begin> will be executed. That callback
		539	is I<supposed> to call C<< ->send >>, but that is not required. If no
		540	callback was set, C<send> will be called without any arguments.
		541
		542	Let's clarify this with the ping example:
		543
		544	my $cv = AnyEvent->condvar;
		545
		546	my %result;
		547	$cv->begin (sub { $cv->send (\%result) });
		548
		549	for my $host (@list_of_hosts) {
		550	$cv->begin;
		551	ping_host_then_call_callback $host, sub {
		552	$result{$host} = ...;
		553	$cv->end;
		554	};
		555	}
		556
		557	$cv->end;
		558
		559	This code fragment supposedly pings a number of hosts and calls
		560	C<send> after results for all then have have been gathered - in any
		561	order. To achieve this, the code issues a call to C<begin> when it starts
		562	each ping request and calls C<end> when it has received some result for
		563	it. Since C<begin> and C<end> only maintain a counter, the order in which
		564	results arrive is not relevant.
		565
		566	There is an additional bracketing call to C<begin> and C<end> outside the
		567	loop, which serves two important purposes: first, it sets the callback
		568	to be called once the counter reaches C<0>, and second, it ensures that
		569	C<send> is called even when C<no> hosts are being pinged (the loop
		570	doesn't execute once).
		571
		572	This is the general pattern when you "fan out" into multiple subrequests:
		573	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
		574	is called at least once, and then, for each subrequest you start, call
		575	C<begin> and for each subrequest you finish, call C<end>.
		576
		577	=back
		578
		579	=head3 METHODS FOR CONSUMERS
		580
		581	These methods should only be used by the consuming side, i.e. the
		582	code awaits the condition.
		583
		584	=over 4
		585
		586	=item $cv->recv
		587
		588	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
351	called on c<$cv>, while servicing other watchers normally.	589	>> methods have been called on c<$cv>, while servicing other watchers
		590	normally.
352		591
353	You can only wait once on a condition - additional calls will return	592	You can only wait once on a condition - additional calls are valid but
354	immediately.	593	will return immediately.
		594
		595	If an error condition has been set by calling C<< ->croak >>, then this
		596	function will call C<croak>.
		597
		598	In list context, all parameters passed to C<send> will be returned,
		599	in scalar context only the first one will be returned.
355		600
356	Not all event models support a blocking wait - some die in that case	601	Not all event models support a blocking wait - some die in that case
357	(programs might want to do that to stay interactive), so I<if you are	602	(programs might want to do that to stay interactive), so I<if you are
358	using this from a module, never require a blocking wait>, but let the	603	using this from a module, never require a blocking wait>, but let the
359	caller decide whether the call will block or not (for example, by coupling	604	caller decide whether the call will block or not (for example, by coupling
360	condition variables with some kind of request results and supporting	605	condition variables with some kind of request results and supporting
361	callbacks so the caller knows that getting the result will not block,	606	callbacks so the caller knows that getting the result will not block,
362	while still suppporting blocking waits if the caller so desires).	607	while still supporting blocking waits if the caller so desires).
363		608
364	Another reason I<never> to C<< ->wait >> in a module is that you cannot	609	Another reason I<never> to C<< ->recv >> in a module is that you cannot
365	sensibly have two C<< ->wait >>'s in parallel, as that would require	610	sensibly have two C<< ->recv >>'s in parallel, as that would require
366	multiple interpreters or coroutines/threads, none of which C<AnyEvent>	611	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
367	can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and	612	can supply.
368	L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
369	from different coroutines, however).
370		613
371	=item $cv->broadcast	614	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
		615	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
		616	versions and also integrates coroutines into AnyEvent, making blocking
		617	C<< ->recv >> calls perfectly safe as long as they are done from another
		618	coroutine (one that doesn't run the event loop).
372		619
373	Flag the condition as ready - a running C<< ->wait >> and all further	620	You can ensure that C<< -recv >> never blocks by setting a callback and
374	calls to C<wait> will (eventually) return after this method has been	621	only calling C<< ->recv >> from within that callback (or at a later
375	called. If nobody is waiting the broadcast will be remembered..	622	time). This will work even when the event loop does not support blocking
		623	waits otherwise.
		624
		625	=item $bool = $cv->ready
		626
		627	Returns true when the condition is "true", i.e. whether C<send> or
		628	C<croak> have been called.
		629
		630	=item $cb = $cv->cb ($cb->($cv))
		631
		632	This is a mutator function that returns the callback set and optionally
		633	replaces it before doing so.
		634
		635	The callback will be called when the condition becomes "true", i.e. when
		636	C<send> or C<croak> are called, with the only argument being the condition
		637	variable itself. Calling C<recv> inside the callback or at any later time
		638	is guaranteed not to block.
376		639
377	=back	640	=back
378
379	Example:
380
381	# wait till the result is ready
382	my $result_ready = AnyEvent->condvar;
383
384	# do something such as adding a timer
385	# or socket watcher the calls $result_ready->broadcast
386	# when the "result" is ready.
387	# in this case, we simply use a timer:
388	my $w = AnyEvent->timer (
389	after => 1,
390	cb => sub { $result_ready->broadcast },
391	);
392
393	# this "blocks" (while handling events) till the watcher
394	# calls broadcast
395	$result_ready->wait;
396		641
397	=head1 GLOBAL VARIABLES AND FUNCTIONS	642	=head1 GLOBAL VARIABLES AND FUNCTIONS
398		643
399	=over 4	644	=over 4
400		645
…		…
406	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	651	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
407	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	652	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
408		653
409	The known classes so far are:	654	The known classes so far are:
410		655
411	AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
412	AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
413	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).	656	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
414	AnyEvent::Impl::Event based on Event, second best choice.	657	AnyEvent::Impl::Event based on Event, second best choice.
		658	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
415	AnyEvent::Impl::Glib based on Glib, third-best choice.	659	AnyEvent::Impl::Glib based on Glib, third-best choice.
416	AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable.
417	AnyEvent::Impl::Tk based on Tk, very bad choice.	660	AnyEvent::Impl::Tk based on Tk, very bad choice.
418	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).	661	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
419	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	662	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
420	AnyEvent::Impl::POE based on POE, not generic enough for full support.	663	AnyEvent::Impl::POE based on POE, not generic enough for full support.
421		664
…		…
434	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	677	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
435	if necessary. You should only call this function right before you would	678	if necessary. You should only call this function right before you would
436	have created an AnyEvent watcher anyway, that is, as late as possible at	679	have created an AnyEvent watcher anyway, that is, as late as possible at
437	runtime.	680	runtime.
438		681
		682	=item $guard = AnyEvent::post_detect { BLOCK }
		683
		684	Arranges for the code block to be executed as soon as the event model is
		685	autodetected (or immediately if this has already happened).
		686
		687	If called in scalar or list context, then it creates and returns an object
		688	that automatically removes the callback again when it is destroyed. See
		689	L<Coro::BDB> for a case where this is useful.
		690
		691	=item @AnyEvent::post_detect
		692
		693	If there are any code references in this array (you can C<push> to it
		694	before or after loading AnyEvent), then they will called directly after
		695	the event loop has been chosen.
		696
		697	You should check C<$AnyEvent::MODEL> before adding to this array, though:
		698	if it contains a true value then the event loop has already been detected,
		699	and the array will be ignored.
		700
		701	Best use C<AnyEvent::post_detect { BLOCK }> instead.
		702
439	=back	703	=back
440		704
441	=head1 WHAT TO DO IN A MODULE	705	=head1 WHAT TO DO IN A MODULE
442		706
443	As a module author, you should C<use AnyEvent> and call AnyEvent methods	707	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
446	Be careful when you create watchers in the module body - AnyEvent will	710	Be careful when you create watchers in the module body - AnyEvent will
447	decide which event module to use as soon as the first method is called, so	711	decide which event module to use as soon as the first method is called, so
448	by calling AnyEvent in your module body you force the user of your module	712	by calling AnyEvent in your module body you force the user of your module
449	to load the event module first.	713	to load the event module first.
450		714
451	Never call C<< ->wait >> on a condition variable unless you I<know> that	715	Never call C<< ->recv >> on a condition variable unless you I<know> that
452	the C<< ->broadcast >> method has been called on it already. This is	716	the C<< ->send >> method has been called on it already. This is
453	because it will stall the whole program, and the whole point of using	717	because it will stall the whole program, and the whole point of using
454	events is to stay interactive.	718	events is to stay interactive.
455		719
456	It is fine, however, to call C<< ->wait >> when the user of your module	720	It is fine, however, to call C<< ->recv >> when the user of your module
457	requests it (i.e. if you create a http request object ad have a method	721	requests it (i.e. if you create a http request object ad have a method
458	called C<results> that returns the results, it should call C<< ->wait >>	722	called C<results> that returns the results, it should call C<< ->recv >>
459	freely, as the user of your module knows what she is doing. always).	723	freely, as the user of your module knows what she is doing. always).
460		724
461	=head1 WHAT TO DO IN THE MAIN PROGRAM	725	=head1 WHAT TO DO IN THE MAIN PROGRAM
462		726
463	There will always be a single main program - the only place that should	727	There will always be a single main program - the only place that should
…		…
465		729
466	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	730	If it doesn't care, it can just "use AnyEvent" and use it itself, or not
467	do anything special (it does not need to be event-based) and let AnyEvent	731	do anything special (it does not need to be event-based) and let AnyEvent
468	decide which implementation to chose if some module relies on it.	732	decide which implementation to chose if some module relies on it.
469		733
470	If the main program relies on a specific event model. For example, in	734	If the main program relies on a specific event model - for example, in
471	Gtk2 programs you have to rely on the Glib module. You should load the	735	Gtk2 programs you have to rely on the Glib module - you should load the
472	event module before loading AnyEvent or any module that uses it: generally	736	event module before loading AnyEvent or any module that uses it: generally
473	speaking, you should load it as early as possible. The reason is that	737	speaking, you should load it as early as possible. The reason is that
474	modules might create watchers when they are loaded, and AnyEvent will	738	modules might create watchers when they are loaded, and AnyEvent will
475	decide on the event model to use as soon as it creates watchers, and it	739	decide on the event model to use as soon as it creates watchers, and it
476	might chose the wrong one unless you load the correct one yourself.	740	might chose the wrong one unless you load the correct one yourself.
477		741
478	You can chose to use a rather inefficient pure-perl implementation by	742	You can chose to use a pure-perl implementation by loading the
479	loading the C<AnyEvent::Impl::Perl> module, which gives you similar	743	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
480	behaviour everywhere, but letting AnyEvent chose is generally better.	744	everywhere, but letting AnyEvent chose the model is generally better.
		745
		746	=head2 MAINLOOP EMULATION
		747
		748	Sometimes (often for short test scripts, or even standalone programs who
		749	only want to use AnyEvent), you do not want to run a specific event loop.
		750
		751	In that case, you can use a condition variable like this:
		752
		753	AnyEvent->condvar->recv;
		754
		755	This has the effect of entering the event loop and looping forever.
		756
		757	Note that usually your program has some exit condition, in which case
		758	it is better to use the "traditional" approach of storing a condition
		759	variable somewhere, waiting for it, and sending it when the program should
		760	exit cleanly.
		761
481		762
482	=head1 OTHER MODULES	763	=head1 OTHER MODULES
483		764
484	L<AnyEvent> itself comes with useful utility modules:	765	The following is a non-exhaustive list of additional modules that use
485		766	AnyEvent and can therefore be mixed easily with other AnyEvent modules
486	To make it easier to do non-blocking IO the modules L<AnyEvent::Handle>	767	in the same program. Some of the modules come with AnyEvent, some are
487	and L<AnyEvent::Socket> are provided. L<AnyEvent::Handle> provides	768	available via CPAN.
488	read and write buffers and manages watchers for reads and writes.
489	L<AnyEvent::Socket> provides means to do non-blocking connects.
490
491	Aside from those there are these modules that support AnyEvent (and use it
492	for non-blocking IO):
493		769
494	=over 4	770	=over 4
495		771
		772	=item L<AnyEvent::Util>
		773
		774	Contains various utility functions that replace often-used but blocking
		775	functions such as C<inet_aton> by event-/callback-based versions.
		776
		777	=item L<AnyEvent::Socket>
		778
		779	Provides various utility functions for (internet protocol) sockets,
		780	addresses and name resolution. Also functions to create non-blocking tcp
		781	connections or tcp servers, with IPv6 and SRV record support and more.
		782
		783	=item L<AnyEvent::Handle>
		784
		785	Provide read and write buffers, manages watchers for reads and writes,
		786	supports raw and formatted I/O, I/O queued and fully transparent and
		787	non-blocking SSL/TLS.
		788
		789	=item L<AnyEvent::DNS>
		790
		791	Provides rich asynchronous DNS resolver capabilities.
		792
		793	=item L<AnyEvent::HTTP>
		794
		795	A simple-to-use HTTP library that is capable of making a lot of concurrent
		796	HTTP requests.
		797
		798	=item L<AnyEvent::HTTPD>
		799
		800	Provides a simple web application server framework.
		801
496	=item L<AnyEvent::FastPing>	802	=item L<AnyEvent::FastPing>
497		803
		804	The fastest ping in the west.
		805
		806	=item L<AnyEvent::DBI>
		807
		808	Executes L<DBI> requests asynchronously in a proxy process.
		809
		810	=item L<AnyEvent::AIO>
		811
		812	Truly asynchronous I/O, should be in the toolbox of every event
		813	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
		814	together.
		815
		816	=item L<AnyEvent::BDB>
		817
		818	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
		819	L<BDB> and AnyEvent together.
		820
		821	=item L<AnyEvent::GPSD>
		822
		823	A non-blocking interface to gpsd, a daemon delivering GPS information.
		824
		825	=item L<AnyEvent::IGS>
		826
		827	A non-blocking interface to the Internet Go Server protocol (used by
		828	L<App::IGS>).
		829
498	=item L<Net::IRC3>	830	=item L<AnyEvent::IRC>
		831
		832	AnyEvent based IRC client module family (replacing the older Net::IRC3).
499		833
500	=item L<Net::XMPP2>	834	=item L<Net::XMPP2>
501		835
		836	AnyEvent based XMPP (Jabber protocol) module family.
		837
		838	=item L<Net::FCP>
		839
		840	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
		841	of AnyEvent.
		842
		843	=item L<Event::ExecFlow>
		844
		845	High level API for event-based execution flow control.
		846
		847	=item L<Coro>
		848
		849	Has special support for AnyEvent via L<Coro::AnyEvent>.
		850
		851	=item L<IO::Lambda>
		852
		853	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
		854
502	=back	855	=back
503		856
504	=cut	857	=cut
505		858
506	package AnyEvent;	859	package AnyEvent;
507		860
508	no warnings;	861	no warnings;
509	use strict;	862	use strict qw(vars subs);
510		863
511	use Carp;	864	use Carp;
512		865
513	our $VERSION = '3.3';	866	our $VERSION = 4.341;
514	our $MODEL;	867	our $MODEL;
515		868
516	our $AUTOLOAD;	869	our $AUTOLOAD;
517	our @ISA;	870	our @ISA;
518		871
		872	our @REGISTRY;
		873
		874	our $WIN32;
		875
		876	BEGIN {
		877	my $win32 = ! ! ($^O =~ /mswin32/i);
		878	eval "sub WIN32(){ $win32 }";
		879	}
		880
519	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	881	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
520		882
521	our @REGISTRY;	883	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
		884
		885	{
		886	my $idx;
		887	$PROTOCOL{$_} = ++$idx
		888	for reverse split /\s*,\s*/,
		889	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
		890	}
522		891
523	my @models = (	892	my @models = (
524	[Coro::EV:: => AnyEvent::Impl::CoroEV::],
525	[Coro::Event:: => AnyEvent::Impl::CoroEvent::],
526	[EV:: => AnyEvent::Impl::EV::],	893	[EV:: => AnyEvent::Impl::EV::],
527	[Event:: => AnyEvent::Impl::Event::],	894	[Event:: => AnyEvent::Impl::Event::],
528	[Glib:: => AnyEvent::Impl::Glib::],
529	[Tk:: => AnyEvent::Impl::Tk::],
530	[Wx:: => AnyEvent::Impl::POE::],
531	[Prima:: => AnyEvent::Impl::POE::],
532	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	895	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
533	# everything below here will not be autoprobed as the pureperl backend should work everywhere	896	# everything below here will not be autoprobed
		897	# as the pureperl backend should work everywhere
		898	# and is usually faster
		899	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		900	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
534	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	901	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
535	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	902	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
536	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	903	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
		904	[Wx:: => AnyEvent::Impl::POE::],
		905	[Prima:: => AnyEvent::Impl::POE::],
537	);	906	);
538		907
539	our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY);	908	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
		909
		910	our @post_detect;
		911
		912	sub post_detect(&) {
		913	my ($cb) = @_;
		914
		915	if ($MODEL) {
		916	$cb->();
		917
		918	1
		919	} else {
		920	push @post_detect, $cb;
		921
		922	defined wantarray
		923	? bless \$cb, "AnyEvent::Util::PostDetect"
		924	: ()
		925	}
		926	}
		927
		928	sub AnyEvent::Util::PostDetect::DESTROY {
		929	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		930	}
540		931
541	sub detect() {	932	sub detect() {
542	unless ($MODEL) {	933	unless ($MODEL) {
543	no strict 'refs';	934	no strict 'refs';
		935	local $SIG{__DIE__};
544		936
545	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	937	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
546	my $model = "AnyEvent::Impl::$1";	938	my $model = "AnyEvent::Impl::$1";
547	if (eval "require $model") {	939	if (eval "require $model") {
548	$MODEL = $model;	940	$MODEL = $model;
…		…
578	last;	970	last;
579	}	971	}
580	}	972	}
581		973
582	$MODEL	974	$MODEL
583	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV (or Coro+EV), Event (or Coro+Event) or Glib.";	975	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
584	}	976	}
585	}	977	}
586		978
		979	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		980
587	unshift @ISA, $MODEL;	981	unshift @ISA, $MODEL;
588	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	982
		983	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		984
		985	(shift @post_detect)->() while @post_detect;
589	}	986	}
590		987
591	$MODEL	988	$MODEL
592	}	989	}
593		990
…		…
601		998
602	my $class = shift;	999	my $class = shift;
603	$class->$func (@_);	1000	$class->$func (@_);
604	}	1001	}
605		1002
		1003	# utility function to dup a filehandle. this is used by many backends
		1004	# to support binding more than one watcher per filehandle (they usually
		1005	# allow only one watcher per fd, so we dup it to get a different one).
		1006	sub _dupfh($$$$) {
		1007	my ($poll, $fh, $r, $w) = @_;
		1008
		1009	# cygwin requires the fh mode to be matching, unix doesn't
		1010	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
		1011	: $poll eq "w" ? ($w, ">")
		1012	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
		1013
		1014	open my $fh2, "$mode&" . fileno $fh
		1015	or die "cannot dup() filehandle: $!";
		1016
		1017	# we assume CLOEXEC is already set by perl in all important cases
		1018
		1019	($fh2, $rw)
		1020	}
		1021
606	package AnyEvent::Base;	1022	package AnyEvent::Base;
607		1023
		1024	# default implementation for now and time
		1025
		1026	BEGIN {
		1027	if (eval "use Time::HiRes (); time (); 1") {
		1028	*_time = \&Time::HiRes::time;
		1029	# if (eval "use POSIX (); (POSIX::times())...
		1030	} else {
		1031	*_time = sub { time }; # epic fail
		1032	}
		1033	}
		1034
		1035	sub time { _time }
		1036	sub now { _time }
		1037
608	# default implementation for ->condvar, ->wait, ->broadcast	1038	# default implementation for ->condvar
609		1039
610	sub condvar {	1040	sub condvar {
611	bless \my $flag, "AnyEvent::Base::CondVar"	1041	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
612	}
613
614	sub AnyEvent::Base::CondVar::broadcast {
615	${$_[0]}++;
616	}
617
618	sub AnyEvent::Base::CondVar::wait {
619	AnyEvent->one_event while !${$_[0]};
620	}	1042	}
621		1043
622	# default implementation for ->signal	1044	# default implementation for ->signal
623		1045
624	our %SIG_CB;	1046	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1047
		1048	sub _signal_exec {
		1049	while (%SIG_EV) {
		1050	sysread $SIGPIPE_R, my $dummy, 4;
		1051	for (keys %SIG_EV) {
		1052	delete $SIG_EV{$_};
		1053	$_->() for values %{ $SIG_CB{$_} || {} };
		1054	}
		1055	}
		1056	}
625		1057
626	sub signal {	1058	sub signal {
627	my (undef, %arg) = @_;	1059	my (undef, %arg) = @_;
628		1060
		1061	unless ($SIGPIPE_R) {
		1062	if (AnyEvent::WIN32) {
		1063	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1064	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1065	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1066	} else {
		1067	pipe $SIGPIPE_R, $SIGPIPE_W;
		1068	require Fcntl;
		1069	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1070	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1071	}
		1072
		1073	$SIGPIPE_R
		1074	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1075
		1076	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1077	}
		1078
629	my $signal = uc $arg{signal}	1079	my $signal = uc $arg{signal}
630	or Carp::croak "required option 'signal' is missing";	1080	or Carp::croak "required option 'signal' is missing";
631		1081
632	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1082	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
633	$SIG{$signal} ||= sub {	1083	$SIG{$signal} ||= sub {
634	$_->() for values %{ $SIG_CB{$signal} || {} };	1084	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1085	undef $SIG_EV{$signal};
635	};	1086	};
636		1087
637	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1088	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
638	}	1089	}
639		1090
640	sub AnyEvent::Base::Signal::DESTROY {	1091	sub AnyEvent::Base::Signal::DESTROY {
641	my ($signal, $cb) = @{$_[0]};	1092	my ($signal, $cb) = @{$_[0]};
642		1093
643	delete $SIG_CB{$signal}{$cb};	1094	delete $SIG_CB{$signal}{$cb};
644		1095
645	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };	1096	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
646	}	1097	}
647		1098
648	# default implementation for ->child	1099	# default implementation for ->child
649		1100
650	our %PID_CB;	1101	our %PID_CB;
…		…
677	or Carp::croak "required option 'pid' is missing";	1128	or Carp::croak "required option 'pid' is missing";
678		1129
679	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1130	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
680		1131
681	unless ($WNOHANG) {	1132	unless ($WNOHANG) {
682	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1;	1133	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
683	}	1134	}
684		1135
685	unless ($CHLD_W) {	1136	unless ($CHLD_W) {
686	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1137	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
687	# child could be a zombie already, so make at least one round	1138	# child could be a zombie already, so make at least one round
…		…
697	delete $PID_CB{$pid}{$cb};	1148	delete $PID_CB{$pid}{$cb};
698	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1149	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
699		1150
700	undef $CHLD_W unless keys %PID_CB;	1151	undef $CHLD_W unless keys %PID_CB;
701	}	1152	}
		1153
		1154	package AnyEvent::CondVar;
		1155
		1156	our @ISA = AnyEvent::CondVar::Base::;
		1157
		1158	package AnyEvent::CondVar::Base;
		1159
		1160	use overload
		1161	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		1162	fallback => 1;
		1163
		1164	sub _send {
		1165	# nop
		1166	}
		1167
		1168	sub send {
		1169	my $cv = shift;
		1170	$cv->{_ae_sent} = [@_];
		1171	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
		1172	$cv->_send;
		1173	}
		1174
		1175	sub croak {
		1176	$_[0]{_ae_croak} = $_[1];
		1177	$_[0]->send;
		1178	}
		1179
		1180	sub ready {
		1181	$_[0]{_ae_sent}
		1182	}
		1183
		1184	sub _wait {
		1185	AnyEvent->one_event while !$_[0]{_ae_sent};
		1186	}
		1187
		1188	sub recv {
		1189	$_[0]->_wait;
		1190
		1191	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
		1192	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
		1193	}
		1194
		1195	sub cb {
		1196	$_[0]{_ae_cb} = $_[1] if @_ > 1;
		1197	$_[0]{_ae_cb}
		1198	}
		1199
		1200	sub begin {
		1201	++$_[0]{_ae_counter};
		1202	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
		1203	}
		1204
		1205	sub end {
		1206	return if --$_[0]{_ae_counter};
		1207	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
		1208	}
		1209
		1210	# undocumented/compatibility with pre-3.4
		1211	*broadcast = \&send;
		1212	*wait = \&_wait;
		1213
		1214	=head1 ERROR AND EXCEPTION HANDLING
		1215
		1216	In general, AnyEvent does not do any error handling - it relies on the
		1217	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1218	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1219	checking of all AnyEvent methods, however, which is highly useful during
		1220	development.
		1221
		1222	As for exception handling (i.e. runtime errors and exceptions thrown while
		1223	executing a callback), this is not only highly event-loop specific, but
		1224	also not in any way wrapped by this module, as this is the job of the main
		1225	program.
		1226
		1227	The pure perl event loop simply re-throws the exception (usually
		1228	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1229	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1230	so on.
		1231
		1232	=head1 ENVIRONMENT VARIABLES
		1233
		1234	The following environment variables are used by this module or its
		1235	submodules:
		1236
		1237	=over 4
		1238
		1239	=item C<PERL_ANYEVENT_VERBOSE>
		1240
		1241	By default, AnyEvent will be completely silent except in fatal
		1242	conditions. You can set this environment variable to make AnyEvent more
		1243	talkative.
		1244
		1245	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1246	conditions, such as not being able to load the event model specified by
		1247	C<PERL_ANYEVENT_MODEL>.
		1248
		1249	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1250	model it chooses.
		1251
		1252	=item C<PERL_ANYEVENT_STRICT>
		1253
		1254	AnyEvent does not do much argument checking by default, as thorough
		1255	argument checking is very costly. Setting this variable to a true value
		1256	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1257	check the arguments passed to most method calls. If it finds any problems
		1258	it will croak.
		1259
		1260	In other words, enables "strict" mode.
		1261
		1262	Unlike C<use strict>, it is definitely recommended ot keep it off in
		1263	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
		1264	developing programs can be very useful, however.
		1265
		1266	=item C<PERL_ANYEVENT_MODEL>
		1267
		1268	This can be used to specify the event model to be used by AnyEvent, before
		1269	auto detection and -probing kicks in. It must be a string consisting
		1270	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1271	and the resulting module name is loaded and if the load was successful,
		1272	used as event model. If it fails to load AnyEvent will proceed with
		1273	auto detection and -probing.
		1274
		1275	This functionality might change in future versions.
		1276
		1277	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1278	could start your program like this:
		1279
		1280	PERL_ANYEVENT_MODEL=Perl perl ...
		1281
		1282	=item C<PERL_ANYEVENT_PROTOCOLS>
		1283
		1284	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1285	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1286	of auto probing).
		1287
		1288	Must be set to a comma-separated list of protocols or address families,
		1289	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1290	used, and preference will be given to protocols mentioned earlier in the
		1291	list.
		1292
		1293	This variable can effectively be used for denial-of-service attacks
		1294	against local programs (e.g. when setuid), although the impact is likely
		1295	small, as the program has to handle conenction and other failures anyways.
		1296
		1297	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1298	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1299	- only support IPv4, never try to resolve or contact IPv6
		1300	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1301	IPv6, but prefer IPv6 over IPv4.
		1302
		1303	=item C<PERL_ANYEVENT_EDNS0>
		1304
		1305	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1306	for DNS. This extension is generally useful to reduce DNS traffic, but
		1307	some (broken) firewalls drop such DNS packets, which is why it is off by
		1308	default.
		1309
		1310	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1311	EDNS0 in its DNS requests.
		1312
		1313	=item C<PERL_ANYEVENT_MAX_FORKS>
		1314
		1315	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1316	will create in parallel.
		1317
		1318	=back
702		1319
703	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1320	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
704		1321
705	This is an advanced topic that you do not normally need to use AnyEvent in	1322	This is an advanced topic that you do not normally need to use AnyEvent in
706	a module. This section is only of use to event loop authors who want to	1323	a module. This section is only of use to event loop authors who want to
…		…
740		1357
741	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1358	I<rxvt-unicode> also cheats a bit by not providing blocking access to
742	condition variables: code blocking while waiting for a condition will	1359	condition variables: code blocking while waiting for a condition will
743	C<die>. This still works with most modules/usages, and blocking calls must	1360	C<die>. This still works with most modules/usages, and blocking calls must
744	not be done in an interactive application, so it makes sense.	1361	not be done in an interactive application, so it makes sense.
745
746	=head1 ENVIRONMENT VARIABLES
747
748	The following environment variables are used by this module:
749
750	=over 4
751
752	=item C<PERL_ANYEVENT_VERBOSE>
753
754	By default, AnyEvent will be completely silent except in fatal
755	conditions. You can set this environment variable to make AnyEvent more
756	talkative.
757
758	When set to C<1> or higher, causes AnyEvent to warn about unexpected
759	conditions, such as not being able to load the event model specified by
760	C<PERL_ANYEVENT_MODEL>.
761
762	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
763	model it chooses.
764
765	=item C<PERL_ANYEVENT_MODEL>
766
767	This can be used to specify the event model to be used by AnyEvent, before
768	autodetection and -probing kicks in. It must be a string consisting
769	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
770	and the resulting module name is loaded and if the load was successful,
771	used as event model. If it fails to load AnyEvent will proceed with
772	autodetection and -probing.
773
774	This functionality might change in future versions.
775
776	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
777	could start your program like this:
778
779	PERL_ANYEVENT_MODEL=Perl perl ...
780
781	=back
782		1362
783	=head1 EXAMPLE PROGRAM	1363	=head1 EXAMPLE PROGRAM
784		1364
785	The following program uses an I/O watcher to read data from STDIN, a timer	1365	The following program uses an I/O watcher to read data from STDIN, a timer
786	to display a message once per second, and a condition variable to quit the	1366	to display a message once per second, and a condition variable to quit the
…		…
795	poll => 'r',	1375	poll => 'r',
796	cb => sub {	1376	cb => sub {
797	warn "io event <$_[0]>\n"; # will always output <r>	1377	warn "io event <$_[0]>\n"; # will always output <r>
798	chomp (my $input = <STDIN>); # read a line	1378	chomp (my $input = <STDIN>); # read a line
799	warn "read: $input\n"; # output what has been read	1379	warn "read: $input\n"; # output what has been read
800	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i	1380	$cv->send if $input =~ /^q/i; # quit program if /^q/i
801	},	1381	},
802	);	1382	);
803		1383
804	my $time_watcher; # can only be used once	1384	my $time_watcher; # can only be used once
805		1385
…		…
810	});	1390	});
811	}	1391	}
812		1392
813	new_timer; # create first timer	1393	new_timer; # create first timer
814		1394
815	$cv->wait; # wait until user enters /^q/i	1395	$cv->recv; # wait until user enters /^q/i
816		1396
817	=head1 REAL-WORLD EXAMPLE	1397	=head1 REAL-WORLD EXAMPLE
818		1398
819	Consider the L<Net::FCP> module. It features (among others) the following	1399	Consider the L<Net::FCP> module. It features (among others) the following
820	API calls, which are to freenet what HTTP GET requests are to http:	1400	API calls, which are to freenet what HTTP GET requests are to http:
…		…
870	syswrite $txn->{fh}, $txn->{request}	1450	syswrite $txn->{fh}, $txn->{request}
871	or die "connection or write error";	1451	or die "connection or write error";
872	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	1452	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
873		1453
874	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	1454	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
875	result and signals any possible waiters that the request ahs finished:	1455	result and signals any possible waiters that the request has finished:
876		1456
877	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	1457	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
878		1458
879	if (end-of-file or data complete) {	1459	if (end-of-file or data complete) {
880	$txn->{result} = $txn->{buf};	1460	$txn->{result} = $txn->{buf};
881	$txn->{finished}->broadcast;	1461	$txn->{finished}->send;
882	$txb->{cb}->($txn) of $txn->{cb}; # also call callback	1462	$txb->{cb}->($txn) of $txn->{cb}; # also call callback
883	}	1463	}
884		1464
885	The C<result> method, finally, just waits for the finished signal (if the	1465	The C<result> method, finally, just waits for the finished signal (if the
886	request was already finished, it doesn't wait, of course, and returns the	1466	request was already finished, it doesn't wait, of course, and returns the
887	data:	1467	data:
888		1468
889	$txn->{finished}->wait;	1469	$txn->{finished}->recv;
890	return $txn->{result};	1470	return $txn->{result};
891		1471
892	The actual code goes further and collects all errors (C<die>s, exceptions)	1472	The actual code goes further and collects all errors (C<die>s, exceptions)
893	that occured during request processing. The C<result> method detects	1473	that occurred during request processing. The C<result> method detects
894	whether an exception as thrown (it is stored inside the $txn object)	1474	whether an exception as thrown (it is stored inside the $txn object)
895	and just throws the exception, which means connection errors and other	1475	and just throws the exception, which means connection errors and other
896	problems get reported tot he code that tries to use the result, not in a	1476	problems get reported tot he code that tries to use the result, not in a
897	random callback.	1477	random callback.
898		1478
…		…
929		1509
930	my $quit = AnyEvent->condvar;	1510	my $quit = AnyEvent->condvar;
931		1511
932	$fcp->txn_client_get ($url)->cb (sub {	1512	$fcp->txn_client_get ($url)->cb (sub {
933	...	1513	...
934	$quit->broadcast;	1514	$quit->send;
935	});	1515	});
936		1516
937	$quit->wait;	1517	$quit->recv;
938		1518
939		1519
940	=head1 BENCHMARKS	1520	=head1 BENCHMARKS
941		1521
942	To give you an idea of the performance and overheads that AnyEvent adds	1522	To give you an idea of the performance and overheads that AnyEvent adds
…		…
944	of various event loops I prepared some benchmarks.	1524	of various event loops I prepared some benchmarks.
945		1525
946	=head2 BENCHMARKING ANYEVENT OVERHEAD	1526	=head2 BENCHMARKING ANYEVENT OVERHEAD
947		1527
948	Here is a benchmark of various supported event models used natively and	1528	Here is a benchmark of various supported event models used natively and
949	through anyevent. The benchmark creates a lot of timers (with a zero	1529	through AnyEvent. The benchmark creates a lot of timers (with a zero
950	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	1530	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
951	which it is), lets them fire exactly once and destroys them again.	1531	which it is), lets them fire exactly once and destroys them again.
952		1532
953	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	1533	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
954	distribution.	1534	distribution.
…		…
971	all watchers, to avoid adding memory overhead. That means closure creation	1551	all watchers, to avoid adding memory overhead. That means closure creation
972	and memory usage is not included in the figures.	1552	and memory usage is not included in the figures.
973		1553
974	I<invoke> is the time, in microseconds, used to invoke a simple	1554	I<invoke> is the time, in microseconds, used to invoke a simple
975	callback. The callback simply counts down a Perl variable and after it was	1555	callback. The callback simply counts down a Perl variable and after it was
976	invoked "watcher" times, it would C<< ->broadcast >> a condvar once to	1556	invoked "watcher" times, it would C<< ->send >> a condvar once to
977	signal the end of this phase.	1557	signal the end of this phase.
978		1558
979	I<destroy> is the time, in microseconds, that it takes to destroy a single	1559	I<destroy> is the time, in microseconds, that it takes to destroy a single
980	watcher.	1560	watcher.
981		1561
982	=head3 Results	1562	=head3 Results
983		1563
984	name watchers bytes create invoke destroy comment	1564	name watchers bytes create invoke destroy comment
985	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1565	EV/EV 400000 224 0.47 0.35 0.27 EV native interface
986	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	1566	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
987	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	1567	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
988	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	1568	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
989	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	1569	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
990	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	1570	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
991	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	1571	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
992	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	1572	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
993	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	1573	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
994	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	1574	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
995		1575
996	=head3 Discussion	1576	=head3 Discussion
997		1577
998	The benchmark does I<not> measure scalability of the event loop very	1578	The benchmark does I<not> measure scalability of the event loop very
999	well. For example, a select-based event loop (such as the pure perl one)	1579	well. For example, a select-based event loop (such as the pure perl one)
…		…
1041	file descriptor is dup()ed for each watcher. This shows that the dup()	1621	file descriptor is dup()ed for each watcher. This shows that the dup()
1042	employed by some adaptors is not a big performance issue (it does incur a	1622	employed by some adaptors is not a big performance issue (it does incur a
1043	hidden memory cost inside the kernel which is not reflected in the figures	1623	hidden memory cost inside the kernel which is not reflected in the figures
1044	above).	1624	above).
1045		1625
1046	C<POE>, regardless of underlying event loop (whether using its pure	1626	C<POE>, regardless of underlying event loop (whether using its pure perl
1047	perl select-based backend or the Event module, the POE-EV backend	1627	select-based backend or the Event module, the POE-EV backend couldn't
1048	couldn't be tested because it wasn't working) shows abysmal performance	1628	be tested because it wasn't working) shows abysmal performance and
1049	and memory usage: Watchers use almost 30 times as much memory as	1629	memory usage with AnyEvent: Watchers use almost 30 times as much memory
1050	EV watchers, and 10 times as much memory as Event (the high memory	1630	as EV watchers, and 10 times as much memory as Event (the high memory
1051	requirements are caused by requiring a session for each watcher). Watcher	1631	requirements are caused by requiring a session for each watcher). Watcher
1052	invocation speed is almost 900 times slower than with AnyEvent's pure perl	1632	invocation speed is almost 900 times slower than with AnyEvent's pure perl
		1633	implementation.
		1634
1053	implementation. The design of the POE adaptor class in AnyEvent can not	1635	The design of the POE adaptor class in AnyEvent can not really account
1054	really account for this, as session creation overhead is small compared	1636	for the performance issues, though, as session creation overhead is
1055	to execution of the state machine, which is coded pretty optimally within	1637	small compared to execution of the state machine, which is coded pretty
1056	L<AnyEvent::Impl::POE>. POE simply seems to be abysmally slow.	1638	optimally within L<AnyEvent::Impl::POE> (and while everybody agrees that
		1639	using multiple sessions is not a good approach, especially regarding
		1640	memory usage, even the author of POE could not come up with a faster
		1641	design).
1057		1642
1058	=head3 Summary	1643	=head3 Summary
1059		1644
1060	=over 4	1645	=over 4
1061		1646
…		…
1072		1657
1073	=back	1658	=back
1074		1659
1075	=head2 BENCHMARKING THE LARGE SERVER CASE	1660	=head2 BENCHMARKING THE LARGE SERVER CASE
1076		1661
1077	This benchmark atcually benchmarks the event loop itself. It works by	1662	This benchmark actually benchmarks the event loop itself. It works by
1078	creating a number of "servers": each server consists of a socketpair, a	1663	creating a number of "servers": each server consists of a socket pair, a
1079	timeout watcher that gets reset on activity (but never fires), and an I/O	1664	timeout watcher that gets reset on activity (but never fires), and an I/O
1080	watcher waiting for input on one side of the socket. Each time the socket	1665	watcher waiting for input on one side of the socket. Each time the socket
1081	watcher reads a byte it will write that byte to a random other "server".	1666	watcher reads a byte it will write that byte to a random other "server".
1082		1667
1083	The effect is that there will be a lot of I/O watchers, only part of which	1668	The effect is that there will be a lot of I/O watchers, only part of which
1084	are active at any one point (so there is a constant number of active	1669	are active at any one point (so there is a constant number of active
1085	fds for each loop iterstaion, but which fds these are is random). The	1670	fds for each loop iteration, but which fds these are is random). The
1086	timeout is reset each time something is read because that reflects how	1671	timeout is reset each time something is read because that reflects how
1087	most timeouts work (and puts extra pressure on the event loops).	1672	most timeouts work (and puts extra pressure on the event loops).
1088		1673
1089	In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100	1674	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1090	(1%) are active. This mirrors the activity of large servers with many	1675	(1%) are active. This mirrors the activity of large servers with many
1091	connections, most of which are idle at any one point in time.	1676	connections, most of which are idle at any one point in time.
1092		1677
1093	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	1678	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1094	distribution.	1679	distribution.
…		…
1096	=head3 Explanation of the columns	1681	=head3 Explanation of the columns
1097		1682
1098	I<sockets> is the number of sockets, and twice the number of "servers" (as	1683	I<sockets> is the number of sockets, and twice the number of "servers" (as
1099	each server has a read and write socket end).	1684	each server has a read and write socket end).
1100		1685
1101	I<create> is the time it takes to create a socketpair (which is	1686	I<create> is the time it takes to create a socket pair (which is
1102	nontrivial) and two watchers: an I/O watcher and a timeout watcher.	1687	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1103		1688
1104	I<request>, the most important value, is the time it takes to handle a	1689	I<request>, the most important value, is the time it takes to handle a
1105	single "request", that is, reading the token from the pipe and forwarding	1690	single "request", that is, reading the token from the pipe and forwarding
1106	it to another server. This includes deleting the old timeout and creating	1691	it to another server. This includes deleting the old timeout and creating
…		…
1140		1725
1141	=head3 Summary	1726	=head3 Summary
1142		1727
1143	=over 4	1728	=over 4
1144		1729
1145	=item * The pure perl implementation performs extremely well, considering	1730	=item * The pure perl implementation performs extremely well.
1146	that it uses select.
1147		1731
1148	=item * Avoid Glib or POE in large projects where performance matters.	1732	=item * Avoid Glib or POE in large projects where performance matters.
1149		1733
1150	=back	1734	=back
1151		1735
…		…
1180	speed most when you have lots of watchers, not when you only have a few of	1764	speed most when you have lots of watchers, not when you only have a few of
1181	them).	1765	them).
1182		1766
1183	EV is again fastest.	1767	EV is again fastest.
1184		1768
1185	The C-based event loops Event and Glib come in second this time, as the	1769	Perl again comes second. It is noticeably faster than the C-based event
1186	overhead of running an iteration is much smaller in C than in Perl (little	1770	loops Event and Glib, although the difference is too small to really
1187	code to execute in the inner loop, and perl's function calling overhead is	1771	matter.
1188	high, and updating all the data structures is costly).
1189
1190	The pure perl event loop is much slower, but still competitive.
1191		1772
1192	POE also performs much better in this case, but is is still far behind the	1773	POE also performs much better in this case, but is is still far behind the
1193	others.	1774	others.
1194		1775
1195	=head3 Summary	1776	=head3 Summary
…		…
1200	watchers, as the management overhead dominates.	1781	watchers, as the management overhead dominates.
1201		1782
1202	=back	1783	=back
1203		1784
1204		1785
		1786	=head1 SIGNALS
		1787
		1788	AnyEvent currently installs handlers for these signals:
		1789
		1790	=over 4
		1791
		1792	=item SIGCHLD
		1793
		1794	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		1795	emulation for event loops that do not support them natively. Also, some
		1796	event loops install a similar handler.
		1797
		1798	=item SIGPIPE
		1799
		1800	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		1801	when AnyEvent gets loaded.
		1802
		1803	The rationale for this is that AnyEvent users usually do not really depend
		1804	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		1805	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		1806	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		1807	some random socket.
		1808
		1809	The rationale for installing a no-op handler as opposed to ignoring it is
		1810	that this way, the handler will be restored to defaults on exec.
		1811
		1812	Feel free to install your own handler, or reset it to defaults.
		1813
		1814	=back
		1815
		1816	=cut
		1817
		1818	$SIG{PIPE} = sub { }
		1819	unless defined $SIG{PIPE};
		1820
		1821
1205	=head1 FORK	1822	=head1 FORK
1206		1823
1207	Most event libraries are not fork-safe. The ones who are usually are	1824	Most event libraries are not fork-safe. The ones who are usually are
1208	because they are so inefficient. Only L<EV> is fully fork-aware.	1825	because they rely on inefficient but fork-safe C<select> or C<poll>
		1826	calls. Only L<EV> is fully fork-aware.
1209		1827
1210	If you have to fork, you must either do so I<before> creating your first	1828	If you have to fork, you must either do so I<before> creating your first
1211	watcher OR you must not use AnyEvent at all in the child.	1829	watcher OR you must not use AnyEvent at all in the child.
1212		1830
1213		1831
…		…
1221	specified in the variable.	1839	specified in the variable.
1222		1840
1223	You can make AnyEvent completely ignore this variable by deleting it	1841	You can make AnyEvent completely ignore this variable by deleting it
1224	before the first watcher gets created, e.g. with a C<BEGIN> block:	1842	before the first watcher gets created, e.g. with a C<BEGIN> block:
1225		1843
1226	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	1844	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1227		1845
1228	use AnyEvent;	1846	use AnyEvent;
		1847
		1848	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
		1849	be used to probe what backend is used and gain other information (which is
		1850	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		1851	$ENV{PERL_ANYEGENT_STRICT}.
		1852
		1853
		1854	=head1 BUGS
		1855
		1856	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		1857	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		1858	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		1859	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
		1860	pronounced).
1229		1861
1230		1862
1231	=head1 SEE ALSO	1863	=head1 SEE ALSO
1232		1864
1233	Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>,	1865	Utility functions: L<AnyEvent::Util>.
1234	L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,	1866
		1867	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1235	L<Event::Lib>, L<Qt>, L<POE>.	1868	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1236		1869
1237	Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>,	1870	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1238	L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>,	1871	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1239	L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>,	1872	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1240	L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>.	1873	L<AnyEvent::Impl::POE>.
1241		1874
		1875	Non-blocking file handles, sockets, TCP clients and
		1876	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
		1877
		1878	Asynchronous DNS: L<AnyEvent::DNS>.
		1879
		1880	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
		1881
1242	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.	1882	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1243		1883
1244		1884
1245	=head1 AUTHOR	1885	=head1 AUTHOR
1246		1886
1247	Marc Lehmann <schmorp@schmorp.de>	1887	Marc Lehmann <schmorp@schmorp.de>
1248	http://home.schmorp.de/	1888	http://home.schmorp.de/
1249		1889
1250	=cut	1890	=cut
1251		1891
1252	1	1892	1
1253		1893

Diff Legend

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