ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.111 by root, Sat May 10 01:02:25 2008 UTC vs.
Revision 1.219 by root, Thu Jun 25 11:16:08 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, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops	5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
		6	event loops.
6		7
7	=head1 SYNOPSIS	8	=head1 SYNOPSIS
8		9
9	use AnyEvent;	10	use AnyEvent;
10		11
		12	# file descriptor readable
11	my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub {	13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
		14
		15	# one-shot or repeating timers
		16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
		17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
		18
		19	print AnyEvent->now; # prints current event loop time
		20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
		21
		22	# POSIX signal
		23	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
		24
		25	# child process exit
		26	my $w = AnyEvent->child (pid => $pid, cb => sub {
		27	my ($pid, $status) = @_;
12	...	28	...
13	});	29	});
14		30
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	31	# called when event loop idle (if applicable)
16	...	32	my $w = AnyEvent->idle (cb => sub { ... });
17	});
18		33
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	34	my $w = AnyEvent->condvar; # stores whether a condition was flagged
		35	$w->send; # wake up current and all future recv's
20	$w->wait; # enters "main loop" till $condvar gets ->send	36	$w->recv; # enters "main loop" till $condvar gets ->send
21	$w->send; # wake up current and all future wait's	37	# use a condvar in callback mode:
		38	$w->cb (sub { $_[0]->recv });
		39
		40	=head1 INTRODUCTION/TUTORIAL
		41
		42	This manpage is mainly a reference manual. If you are interested
		43	in a tutorial or some gentle introduction, have a look at the
		44	L<AnyEvent::Intro> manpage.
22		45
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		47
25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	48	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26	nowadays. So what is different about AnyEvent?	49	nowadays. So what is different about AnyEvent?
27		50
28	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	51	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29	policy> and AnyEvent is I<small and efficient>.	52	policy> and AnyEvent is I<small and efficient>.
30		53
31	First and foremost, I<AnyEvent is not an event model> itself, it only	54	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	55	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,	56	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,	57	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	58	only one event loop can be active at the same time in a process. AnyEvent
36	helps hiding the differences between those event loops.	59	cannot change this, but it can hide the differences between those event
		60	loops.
37		61
38	The goal of AnyEvent is to offer module authors the ability to do event	62	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	63	programming (waiting for I/O or timer events) without subscribing to a
40	religion, a way of living, and most importantly: without forcing your	64	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	65	module users into the same thing by forcing them to use the same event
42	model you use.	66	model you use.
43		67
44	For modules like POE or IO::Async (which is a total misnomer as it is	68	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	69	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	70	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	71	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	72	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.	73	module are I<also> forced to use the same event loop you use.
50		74
51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	75	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	76	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	77	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,	78	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	79	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	80	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	81	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).	82	to AnyEvent, too, so it is future-proof).
59		83
60	In addition to being free of having to use I<the one and only true event	84	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	85	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	86	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	87	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	88	offering the functionality that is necessary, in as thin as a wrapper as
65	technically possible.	89	technically possible.
66		90
		91	Of course, AnyEvent comes with a big (and fully optional!) toolbox
		92	of useful functionality, such as an asynchronous DNS resolver, 100%
		93	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
		94	such as Windows) and lots of real-world knowledge and workarounds for
		95	platform bugs and differences.
		96
67	Of course, if you want lots of policy (this can arguably be somewhat	97	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	98	useful) and you want to force your users to use the one and only event
69	model, you should I<not> use this module.	99	model, you should I<not> use this module.
70		100
71	=head1 DESCRIPTION	101	=head1 DESCRIPTION
72		102
…		…
102	starts using it, all bets are off. Maybe you should tell their authors to	132	starts using it, all bets are off. Maybe you should tell their authors to
103	use AnyEvent so their modules work together with others seamlessly...	133	use AnyEvent so their modules work together with others seamlessly...
104		134
105	The pure-perl implementation of AnyEvent is called	135	The pure-perl implementation of AnyEvent is called
106	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	136	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107	explicitly.	137	explicitly and enjoy the high availability of that event loop :)
108		138
109	=head1 WATCHERS	139	=head1 WATCHERS
110		140
111	AnyEvent has the central concept of a I<watcher>, which is an object that	141	AnyEvent has the central concept of a I<watcher>, which is an object that
112	stores relevant data for each kind of event you are waiting for, such as	142	stores relevant data for each kind of event you are waiting for, such as
113	the callback to call, the filehandle to watch, etc.	143	the callback to call, the file handle to watch, etc.
114		144
115	These watchers are normal Perl objects with normal Perl lifetime. After	145	These watchers are normal Perl objects with normal Perl lifetime. After
116	creating a watcher it will immediately "watch" for events and invoke the	146	creating a watcher it will immediately "watch" for events and invoke the
117	callback when the event occurs (of course, only when the event model	147	callback when the event occurs (of course, only when the event model
118	is in control).	148	is in control).
119		149
		150	Note that B<callbacks must not permanently change global variables>
		151	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
		152	callbacks must not C<die> >>. The former is good programming practise in
		153	Perl and the latter stems from the fact that exception handling differs
		154	widely between event loops.
		155
120	To disable the watcher you have to destroy it (e.g. by setting the	156	To disable the watcher you have to destroy it (e.g. by setting the
121	variable you store it in to C<undef> or otherwise deleting all references	157	variable you store it in to C<undef> or otherwise deleting all references
122	to it).	158	to it).
123		159
124	All watchers are created by calling a method on the C<AnyEvent> class.	160	All watchers are created by calling a method on the C<AnyEvent> class.
…		…
126	Many watchers either are used with "recursion" (repeating timers for	162	Many watchers either are used with "recursion" (repeating timers for
127	example), or need to refer to their watcher object in other ways.	163	example), or need to refer to their watcher object in other ways.
128		164
129	An any way to achieve that is this pattern:	165	An any way to achieve that is this pattern:
130		166
131	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	167	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132	# you can use $w here, for example to undef it	168	# you can use $w here, for example to undef it
133	undef $w;	169	undef $w;
134	});	170	});
135		171
136	Note that C<my $w; $w => combination. This is necessary because in Perl,	172	Note that C<my $w; $w => combination. This is necessary because in Perl,
137	my variables are only visible after the statement in which they are	173	my variables are only visible after the statement in which they are
138	declared.	174	declared.
139		175
140	=head2 I/O WATCHERS	176	=head2 I/O WATCHERS
141		177
142	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
143	with the following mandatory key-value pairs as arguments:	179	with the following mandatory key-value pairs as arguments:
144		180
145	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	181	C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
		182	for events (AnyEvent might or might not keep a reference to this file
		183	handle). Note that only file handles pointing to things for which
		184	non-blocking operation makes sense are allowed. This includes sockets,
		185	most character devices, pipes, fifos and so on, but not for example files
		186	or block devices.
		187
146	for events. C<poll> must be a string that is either C<r> or C<w>,	188	C<poll> must be a string that is either C<r> or C<w>, which creates a
147	which creates a watcher waiting for "r"eadable or "w"ritable events,	189	watcher waiting for "r"eadable or "w"ritable events, respectively.
		190
148	respectively. C<cb> is the callback to invoke each time the file handle	191	C<cb> is the callback to invoke each time the file handle becomes ready.
149	becomes ready.
150		192
151	Although the callback might get passed parameters, their value and	193	Although the callback might get passed parameters, their value and
152	presence is undefined and you cannot rely on them. Portable AnyEvent	194	presence is undefined and you cannot rely on them. Portable AnyEvent
153	callbacks cannot use arguments passed to I/O watcher callbacks.	195	callbacks cannot use arguments passed to I/O watcher callbacks.
154		196
…		…
158		200
159	Some event loops issue spurious readyness notifications, so you should	201	Some event loops issue spurious readyness notifications, so you should
160	always use non-blocking calls when reading/writing from/to your file	202	always use non-blocking calls when reading/writing from/to your file
161	handles.	203	handles.
162		204
163	Example:
164
165	# wait for readability of STDIN, then read a line and disable the watcher	205	Example: wait for readability of STDIN, then read a line and disable the
		206	watcher.
		207
166	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	208	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167	chomp (my $input = <STDIN>);	209	chomp (my $input = <STDIN>);
168	warn "read: $input\n";	210	warn "read: $input\n";
169	undef $w;	211	undef $w;
170	});	212	});
…		…
180		222
181	Although the callback might get passed parameters, their value and	223	Although the callback might get passed parameters, their value and
182	presence is undefined and you cannot rely on them. Portable AnyEvent	224	presence is undefined and you cannot rely on them. Portable AnyEvent
183	callbacks cannot use arguments passed to time watcher callbacks.	225	callbacks cannot use arguments passed to time watcher callbacks.
184		226
185	The timer callback will be invoked at most once: if you want a repeating	227	The callback will normally be invoked once only. If you specify another
186	timer you have to create a new watcher (this is a limitation by both Tk	228	parameter, C<interval>, as a strictly positive number (> 0), then the
187	and Glib).	229	callback will be invoked regularly at that interval (in fractional
		230	seconds) after the first invocation. If C<interval> is specified with a
		231	false value, then it is treated as if it were missing.
188		232
189	Example:	233	The callback will be rescheduled before invoking the callback, but no
		234	attempt is done to avoid timer drift in most backends, so the interval is
		235	only approximate.
190		236
191	# fire an event after 7.7 seconds	237	Example: fire an event after 7.7 seconds.
		238
192	my $w = AnyEvent->timer (after => 7.7, cb => sub {	239	my $w = AnyEvent->timer (after => 7.7, cb => sub {
193	warn "timeout\n";	240	warn "timeout\n";
194	});	241	});
195		242
196	# to cancel the timer:	243	# to cancel the timer:
197	undef $w;	244	undef $w;
198		245
199	Example 2:
200
201	# fire an event after 0.5 seconds, then roughly every second	246	Example 2: fire an event after 0.5 seconds, then roughly every second.
202	my $w;
203		247
204	my $cb = sub {
205	# cancel the old timer while creating a new one
206	$w = AnyEvent->timer (after => 1, cb => $cb);	248	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		249	warn "timeout\n";
207	};	250	};
208
209	# start the "loop" by creating the first watcher
210	$w = AnyEvent->timer (after => 0.5, cb => $cb);
211		251
212	=head3 TIMING ISSUES	252	=head3 TIMING ISSUES
213		253
214	There are two ways to handle timers: based on real time (relative, "fire	254	There are two ways to handle timers: based on real time (relative, "fire
215	in 10 seconds") and based on wallclock time (absolute, "fire at 12	255	in 10 seconds") and based on wallclock time (absolute, "fire at 12
…		…
227	timers.	267	timers.
228		268
229	AnyEvent always prefers relative timers, if available, matching the	269	AnyEvent always prefers relative timers, if available, matching the
230	AnyEvent API.	270	AnyEvent API.
231		271
		272	AnyEvent has two additional methods that return the "current time":
		273
		274	=over 4
		275
		276	=item AnyEvent->time
		277
		278	This returns the "current wallclock time" as a fractional number of
		279	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
		280	return, and the result is guaranteed to be compatible with those).
		281
		282	It progresses independently of any event loop processing, i.e. each call
		283	will check the system clock, which usually gets updated frequently.
		284
		285	=item AnyEvent->now
		286
		287	This also returns the "current wallclock time", but unlike C<time>, above,
		288	this value might change only once per event loop iteration, depending on
		289	the event loop (most return the same time as C<time>, above). This is the
		290	time that AnyEvent's timers get scheduled against.
		291
		292	I<In almost all cases (in all cases if you don't care), this is the
		293	function to call when you want to know the current time.>
		294
		295	This function is also often faster then C<< AnyEvent->time >>, and
		296	thus the preferred method if you want some timestamp (for example,
		297	L<AnyEvent::Handle> uses this to update it's activity timeouts).
		298
		299	The rest of this section is only of relevance if you try to be very exact
		300	with your timing, you can skip it without bad conscience.
		301
		302	For a practical example of when these times differ, consider L<Event::Lib>
		303	and L<EV> and the following set-up:
		304
		305	The event loop is running and has just invoked one of your callback at
		306	time=500 (assume no other callbacks delay processing). In your callback,
		307	you wait a second by executing C<sleep 1> (blocking the process for a
		308	second) and then (at time=501) you create a relative timer that fires
		309	after three seconds.
		310
		311	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
		312	both return C<501>, because that is the current time, and the timer will
		313	be scheduled to fire at time=504 (C<501> + C<3>).
		314
		315	With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
		316	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
		317	last event processing phase started. With L<EV>, your timer gets scheduled
		318	to run at time=503 (C<500> + C<3>).
		319
		320	In one sense, L<Event::Lib> is more exact, as it uses the current time
		321	regardless of any delays introduced by event processing. However, most
		322	callbacks do not expect large delays in processing, so this causes a
		323	higher drift (and a lot more system calls to get the current time).
		324
		325	In another sense, L<EV> is more exact, as your timer will be scheduled at
		326	the same time, regardless of how long event processing actually took.
		327
		328	In either case, if you care (and in most cases, you don't), then you
		329	can get whatever behaviour you want with any event loop, by taking the
		330	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
		331	account.
		332
		333	=item AnyEvent->now_update
		334
		335	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
		336	the current time for each loop iteration (see the discussion of L<<
		337	AnyEvent->now >>, above).
		338
		339	When a callback runs for a long time (or when the process sleeps), then
		340	this "current" time will differ substantially from the real time, which
		341	might affect timers and time-outs.
		342
		343	When this is the case, you can call this method, which will update the
		344	event loop's idea of "current time".
		345
		346	Note that updating the time I<might> cause some events to be handled.
		347
		348	=back
		349
232	=head2 SIGNAL WATCHERS	350	=head2 SIGNAL WATCHERS
233		351
234	You can watch for signals using a signal watcher, C<signal> is the signal	352	You can watch for signals using a signal watcher, C<signal> is the signal
235	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	353	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236	be invoked whenever a signal occurs.	354	callback to be invoked whenever a signal occurs.
237		355
238	Although the callback might get passed parameters, their value and	356	Although the callback might get passed parameters, their value and
239	presence is undefined and you cannot rely on them. Portable AnyEvent	357	presence is undefined and you cannot rely on them. Portable AnyEvent
240	callbacks cannot use arguments passed to signal watcher callbacks.	358	callbacks cannot use arguments passed to signal watcher callbacks.
241		359
242	Multiple signal occurances can be clumped together into one callback	360	Multiple signal occurrences can be clumped together into one callback
243	invocation, and callback invocation will be synchronous. synchronous means	361	invocation, and callback invocation will be synchronous. Synchronous means
244	that it might take a while until the signal gets handled by the process,	362	that it might take a while until the signal gets handled by the process,
245	but it is guarenteed not to interrupt any other callbacks.	363	but it is guaranteed not to interrupt any other callbacks.
246		364
247	The main advantage of using these watchers is that you can share a signal	365	The main advantage of using these watchers is that you can share a signal
248	between multiple watchers.	366	between multiple watchers.
249		367
250	This watcher might use C<%SIG>, so programs overwriting those signals	368	This watcher might use C<%SIG>, so programs overwriting those signals
…		…
257	=head2 CHILD PROCESS WATCHERS	375	=head2 CHILD PROCESS WATCHERS
258		376
259	You can also watch on a child process exit and catch its exit status.	377	You can also watch on a child process exit and catch its exit status.
260		378
261	The child process is specified by the C<pid> argument (if set to C<0>, it	379	The child process is specified by the C<pid> argument (if set to C<0>, it
262	watches for any child process exit). The watcher will trigger as often	380	watches for any child process exit). The watcher will triggered only when
263	as status change for the child are received. This works by installing a	381	the child process has finished and an exit status is available, not on
264	signal handler for C<SIGCHLD>. The callback will be called with the pid	382	any trace events (stopped/continued).
265	and exit status (as returned by waitpid), so unlike other watcher types,	383
266	you I<can> rely on child watcher callback arguments.	384	The callback will be called with the pid and exit status (as returned by
		385	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		386	callback arguments.
		387
		388	This watcher type works by installing a signal handler for C<SIGCHLD>,
		389	and since it cannot be shared, nothing else should use SIGCHLD or reap
		390	random child processes (waiting for specific child processes, e.g. inside
		391	C<system>, is just fine).
267		392
268	There is a slight catch to child watchers, however: you usually start them	393	There is a slight catch to child watchers, however: you usually start them
269	I<after> the child process was created, and this means the process could	394	I<after> the child process was created, and this means the process could
270	have exited already (and no SIGCHLD will be sent anymore).	395	have exited already (and no SIGCHLD will be sent anymore).
271		396
272	Not all event models handle this correctly (POE doesn't), but even for	397	Not all event models handle this correctly (neither POE nor IO::Async do,
		398	see their AnyEvent::Impl manpages for details), but even for event models
273	event models that I<do> handle this correctly, they usually need to be	399	that I<do> handle this correctly, they usually need to be loaded before
274	loaded before the process exits (i.e. before you fork in the first place).	400	the process exits (i.e. before you fork in the first place). AnyEvent's
		401	pure perl event loop handles all cases correctly regardless of when you
		402	start the watcher.
275		403
276	This means you cannot create a child watcher as the very first thing in an	404	This means you cannot create a child watcher as the very first
277	AnyEvent program, you I<have> to create at least one watcher before you	405	thing in an AnyEvent program, you I<have> to create at least one
278	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	406	watcher before you C<fork> the child (alternatively, you can call
		407	C<AnyEvent::detect>).
279		408
280	Example: fork a process and wait for it	409	Example: fork a process and wait for it
281		410
282	my $done = AnyEvent->condvar;	411	my $done = AnyEvent->condvar;
283		412
284	AnyEvent::detect; # force event module to be initialised
285
286	my $pid = fork or exit 5;	413	my $pid = fork or exit 5;
287		414
288	my $w = AnyEvent->child (	415	my $w = AnyEvent->child (
289	pid => $pid,	416	pid => $pid,
290	cb => sub {	417	cb => sub {
291	my ($pid, $status) = @_;	418	my ($pid, $status) = @_;
292	warn "pid $pid exited with status $status";	419	warn "pid $pid exited with status $status";
293	$done->send;	420	$done->send;
294	},	421	},
295	);	422	);
296		423
297	# do something else, then wait for process exit	424	# do something else, then wait for process exit
298	$done->wait;	425	$done->recv;
		426
		427	=head2 IDLE WATCHERS
		428
		429	Sometimes there is a need to do something, but it is not so important
		430	to do it instantly, but only when there is nothing better to do. This
		431	"nothing better to do" is usually defined to be "no other events need
		432	attention by the event loop".
		433
		434	Idle watchers ideally get invoked when the event loop has nothing
		435	better to do, just before it would block the process to wait for new
		436	events. Instead of blocking, the idle watcher is invoked.
		437
		438	Most event loops unfortunately do not really support idle watchers (only
		439	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		440	will simply call the callback "from time to time".
		441
		442	Example: read lines from STDIN, but only process them when the
		443	program is otherwise idle:
		444
		445	my @lines; # read data
		446	my $idle_w;
		447	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		448	push @lines, scalar <STDIN>;
		449
		450	# start an idle watcher, if not already done
		451	$idle_w ||= AnyEvent->idle (cb => sub {
		452	# handle only one line, when there are lines left
		453	if (my $line = shift @lines) {
		454	print "handled when idle: $line";
		455	} else {
		456	# otherwise disable the idle watcher again
		457	undef $idle_w;
		458	}
		459	});
		460	});
299		461
300	=head2 CONDITION VARIABLES	462	=head2 CONDITION VARIABLES
301		463
302	If you are familiar with some event loops you will know that all of them	464	If you are familiar with some event loops you will know that all of them
303	require you to run some blocking "loop", "run" or similar function that	465	require you to run some blocking "loop", "run" or similar function that
…		…
309	The instrument to do that is called a "condition variable", so called	471	The instrument to do that is called a "condition variable", so called
310	because they represent a condition that must become true.	472	because they represent a condition that must become true.
311		473
312	Condition variables can be created by calling the C<< AnyEvent->condvar	474	Condition variables can be created by calling the C<< AnyEvent->condvar
313	>> method, usually without arguments. The only argument pair allowed is	475	>> method, usually without arguments. The only argument pair allowed is
		476
314	C<cb>, which specifies a callback to be called when the condition variable	477	C<cb>, which specifies a callback to be called when the condition variable
315	becomes true.	478	becomes true, with the condition variable as the first argument (but not
		479	the results).
316		480
317	After creation, the conditon variable is "false" until it becomes "true"	481	After creation, the condition variable is "false" until it becomes "true"
318	by calling the C<send> method.	482	by calling the C<send> method (or calling the condition variable as if it
		483	were a callback, read about the caveats in the description for the C<<
		484	->send >> method).
319		485
320	Condition variables are similar to callbacks, except that you can	486	Condition variables are similar to callbacks, except that you can
321	optionally wait for them. They can also be called merge points - points	487	optionally wait for them. They can also be called merge points - points
322	in time where multiple outstandign events have been processed. And yet	488	in time where multiple outstanding events have been processed. And yet
323	another way to call them is transations - each condition variable can be	489	another way to call them is transactions - each condition variable can be
324	used to represent a transaction, which finishes at some point and delivers	490	used to represent a transaction, which finishes at some point and delivers
325	a result.	491	a result.
326		492
327	Condition variables are very useful to signal that something has finished,	493	Condition variables are very useful to signal that something has finished,
328	for example, if you write a module that does asynchronous http requests,	494	for example, if you write a module that does asynchronous http requests,
329	then a condition variable would be the ideal candidate to signal the	495	then a condition variable would be the ideal candidate to signal the
330	availability of results. The user can either act when the callback is	496	availability of results. The user can either act when the callback is
331	called or can synchronously C<< ->wait >> for the results.	497	called or can synchronously C<< ->recv >> for the results.
332		498
333	You can also use them to simulate traditional event loops - for example,	499	You can also use them to simulate traditional event loops - for example,
334	you can block your main program until an event occurs - for example, you	500	you can block your main program until an event occurs - for example, you
335	could C<< ->wait >> in your main program until the user clicks the Quit	501	could C<< ->recv >> in your main program until the user clicks the Quit
336	button of your app, which would C<< ->send >> the "quit" event.	502	button of your app, which would C<< ->send >> the "quit" event.
337		503
338	Note that condition variables recurse into the event loop - if you have	504	Note that condition variables recurse into the event loop - if you have
339	two pieces of code that call C<< ->wait >> in a round-robbin fashion, you	505	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	506	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,	507	you should avoid making a blocking wait yourself, at least in callbacks,
342	as this asks for trouble.	508	as this asks for trouble.
343		509
344	Condition variables are represented by hash refs in perl, and the keys	510	Condition variables are represented by hash refs in perl, and the keys
…		…
349		515
350	There are two "sides" to a condition variable - the "producer side" which	516	There are two "sides" to a condition variable - the "producer side" which
351	eventually calls C<< -> send >>, and the "consumer side", which waits	517	eventually calls C<< -> send >>, and the "consumer side", which waits
352	for the send to occur.	518	for the send to occur.
353		519
354	Example:	520	Example: wait for a timer.
355		521
356	# wait till the result is ready	522	# wait till the result is ready
357	my $result_ready = AnyEvent->condvar;	523	my $result_ready = AnyEvent->condvar;
358		524
359	# do something such as adding a timer	525	# do something such as adding a timer
…		…
365	cb => sub { $result_ready->send },	531	cb => sub { $result_ready->send },
366	);	532	);
367		533
368	# this "blocks" (while handling events) till the callback	534	# this "blocks" (while handling events) till the callback
369	# calls send	535	# calls send
370	$result_ready->wait;	536	$result_ready->recv;
		537
		538	Example: wait for a timer, but take advantage of the fact that
		539	condition variables are also code references.
		540
		541	my $done = AnyEvent->condvar;
		542	my $delay = AnyEvent->timer (after => 5, cb => $done);
		543	$done->recv;
		544
		545	Example: Imagine an API that returns a condvar and doesn't support
		546	callbacks. This is how you make a synchronous call, for example from
		547	the main program:
		548
		549	use AnyEvent::CouchDB;
		550
		551	...
		552
		553	my @info = $couchdb->info->recv;
		554
		555	And this is how you would just ste a callback to be called whenever the
		556	results are available:
		557
		558	$couchdb->info->cb (sub {
		559	my @info = $_[0]->recv;
		560	});
371		561
372	=head3 METHODS FOR PRODUCERS	562	=head3 METHODS FOR PRODUCERS
373		563
374	These methods should only be used by the producing side, i.e. the	564	These methods should only be used by the producing side, i.e. the
375	code/module that eventually sends the signal. Note that it is also	565	code/module that eventually sends the signal. Note that it is also
…		…
378		568
379	=over 4	569	=over 4
380		570
381	=item $cv->send (...)	571	=item $cv->send (...)
382		572
383	Flag the condition as ready - a running C<< ->wait >> and all further	573	Flag the condition as ready - a running C<< ->recv >> and all further
384	calls to C<wait> will (eventually) return after this method has been	574	calls to C<recv> will (eventually) return after this method has been
385	called. If nobody is waiting the send will be remembered.	575	called. If nobody is waiting the send will be remembered.
386		576
387	If a callback has been set on the condition variable, it is called	577	If a callback has been set on the condition variable, it is called
388	immediately from within send.	578	immediately from within send.
389		579
390	Any arguments passed to the C<send> call will be returned by all	580	Any arguments passed to the C<send> call will be returned by all
391	future C<< ->wait >> calls.	581	future C<< ->recv >> calls.
		582
		583	Condition variables are overloaded so one can call them directly
		584	(as a code reference). Calling them directly is the same as calling
		585	C<send>. Note, however, that many C-based event loops do not handle
		586	overloading, so as tempting as it may be, passing a condition variable
		587	instead of a callback does not work. Both the pure perl and EV loops
		588	support overloading, however, as well as all functions that use perl to
		589	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
		590	example).
392		591
393	=item $cv->croak ($error)	592	=item $cv->croak ($error)
394		593
395	Similar to send, but causes all call's wait C<< ->wait >> to invoke	594	Similar to send, but causes all call's to C<< ->recv >> to invoke
396	C<Carp::croak> with the given error message/object/scalar.	595	C<Carp::croak> with the given error message/object/scalar.
397		596
398	This can be used to signal any errors to the condition variable	597	This can be used to signal any errors to the condition variable
399	user/consumer.	598	user/consumer.
400		599
401	=item $cv->begin ([group callback])	600	=item $cv->begin ([group callback])
402		601
403	=item $cv->end	602	=item $cv->end
		603
		604	These two methods are EXPERIMENTAL and MIGHT CHANGE.
404		605
405	These two methods can be used to combine many transactions/events into	606	These two methods can be used to combine many transactions/events into
406	one. For example, a function that pings many hosts in parallel might want	607	one. For example, a function that pings many hosts in parallel might want
407	to use a condition variable for the whole process.	608	to use a condition variable for the whole process.
408		609
…		…
443	doesn't execute once).	644	doesn't execute once).
444		645
445	This is the general pattern when you "fan out" into multiple subrequests:	646	This is the general pattern when you "fan out" into multiple subrequests:
446	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	647	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
447	is called at least once, and then, for each subrequest you start, call	648	is called at least once, and then, for each subrequest you start, call
448	C<begin> and for eahc subrequest you finish, call C<end>.	649	C<begin> and for each subrequest you finish, call C<end>.
449		650
450	=back	651	=back
451		652
452	=head3 METHODS FOR CONSUMERS	653	=head3 METHODS FOR CONSUMERS
453		654
454	These methods should only be used by the consuming side, i.e. the	655	These methods should only be used by the consuming side, i.e. the
455	code awaits the condition.	656	code awaits the condition.
456		657
457	=over 4	658	=over 4
458		659
459	=item $cv->wait	660	=item $cv->recv
460		661
461	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	662	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
462	>> methods have been called on c<$cv>, while servicing other watchers	663	>> methods have been called on c<$cv>, while servicing other watchers
463	normally.	664	normally.
464		665
…		…
475	(programs might want to do that to stay interactive), so I<if you are	676	(programs might want to do that to stay interactive), so I<if you are
476	using this from a module, never require a blocking wait>, but let the	677	using this from a module, never require a blocking wait>, but let the
477	caller decide whether the call will block or not (for example, by coupling	678	caller decide whether the call will block or not (for example, by coupling
478	condition variables with some kind of request results and supporting	679	condition variables with some kind of request results and supporting
479	callbacks so the caller knows that getting the result will not block,	680	callbacks so the caller knows that getting the result will not block,
480	while still suppporting blocking waits if the caller so desires).	681	while still supporting blocking waits if the caller so desires).
481		682
482	Another reason I<never> to C<< ->wait >> in a module is that you cannot	683	Another reason I<never> to C<< ->recv >> in a module is that you cannot
483	sensibly have two C<< ->wait >>'s in parallel, as that would require	684	sensibly have two C<< ->recv >>'s in parallel, as that would require
484	multiple interpreters or coroutines/threads, none of which C<AnyEvent>	685	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
485	can supply.	686	can supply.
486		687
487	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in	688	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
488	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe	689	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
489	versions and also integrates coroutines into AnyEvent, making blocking	690	versions and also integrates coroutines into AnyEvent, making blocking
490	C<< ->wait >> calls perfectly safe as long as they are done from another	691	C<< ->recv >> calls perfectly safe as long as they are done from another
491	coroutine (one that doesn't run the event loop).	692	coroutine (one that doesn't run the event loop).
492		693
493	You can ensure that C<< -wait >> never blocks by setting a callback and	694	You can ensure that C<< -recv >> never blocks by setting a callback and
494	only calling C<< ->wait >> from within that callback (or at a later	695	only calling C<< ->recv >> from within that callback (or at a later
495	time). This will work even when the event loop does not support blocking	696	time). This will work even when the event loop does not support blocking
496	waits otherwise.	697	waits otherwise.
497		698
498	=item $bool = $cv->ready	699	=item $bool = $cv->ready
499		700
500	Returns true when the condition is "true", i.e. whether C<send> or	701	Returns true when the condition is "true", i.e. whether C<send> or
501	C<croak> have been called.	702	C<croak> have been called.
502		703
503	=item $cb = $cv->cb ([new callback])	704	=item $cb = $cv->cb ($cb->($cv))
504		705
505	This is a mutator function that returns the callback set and optionally	706	This is a mutator function that returns the callback set and optionally
506	replaces it before doing so.	707	replaces it before doing so.
507		708
508	The callback will be called when the condition becomes "true", i.e. when	709	The callback will be called when the condition becomes "true", i.e. when
509	C<send> or C<croak> are called. Calling C<wait> inside the callback	710	C<send> or C<croak> are called, with the only argument being the condition
510	or at any later time is guaranteed not to block.	711	variable itself. Calling C<recv> inside the callback or at any later time
		712	is guaranteed not to block.
511		713
512	=back	714	=back
513		715
514	=head1 GLOBAL VARIABLES AND FUNCTIONS	716	=head1 GLOBAL VARIABLES AND FUNCTIONS
515		717
…		…
532	AnyEvent::Impl::Tk based on Tk, very bad choice.	734	AnyEvent::Impl::Tk based on Tk, very bad choice.
533	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).	735	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
534	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	736	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
535	AnyEvent::Impl::POE based on POE, not generic enough for full support.	737	AnyEvent::Impl::POE based on POE, not generic enough for full support.
536		738
		739	# warning, support for IO::Async is only partial, as it is too broken
		740	# and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
		741	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
		742
537	There is no support for WxWidgets, as WxWidgets has no support for	743	There is no support for WxWidgets, as WxWidgets has no support for
538	watching file handles. However, you can use WxWidgets through the	744	watching file handles. However, you can use WxWidgets through the
539	POE Adaptor, as POE has a Wx backend that simply polls 20 times per	745	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
540	second, which was considered to be too horrible to even consider for	746	second, which was considered to be too horrible to even consider for
541	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using	747	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
…		…
555		761
556	Arranges for the code block to be executed as soon as the event model is	762	Arranges for the code block to be executed as soon as the event model is
557	autodetected (or immediately if this has already happened).	763	autodetected (or immediately if this has already happened).
558		764
559	If called in scalar or list context, then it creates and returns an object	765	If called in scalar or list context, then it creates and returns an object
560	that automatically removes the callback again when it is destroyed.	766	that automatically removes the callback again when it is destroyed. See
		767	L<Coro::BDB> for a case where this is useful.
561		768
562	=item @AnyEvent::post_detect	769	=item @AnyEvent::post_detect
563		770
564	If there are any code references in this array (you can C<push> to it	771	If there are any code references in this array (you can C<push> to it
565	before or after loading AnyEvent), then they will called directly after	772	before or after loading AnyEvent), then they will called directly after
…		…
581	Be careful when you create watchers in the module body - AnyEvent will	788	Be careful when you create watchers in the module body - AnyEvent will
582	decide which event module to use as soon as the first method is called, so	789	decide which event module to use as soon as the first method is called, so
583	by calling AnyEvent in your module body you force the user of your module	790	by calling AnyEvent in your module body you force the user of your module
584	to load the event module first.	791	to load the event module first.
585		792
586	Never call C<< ->wait >> on a condition variable unless you I<know> that	793	Never call C<< ->recv >> on a condition variable unless you I<know> that
587	the C<< ->send >> method has been called on it already. This is	794	the C<< ->send >> method has been called on it already. This is
588	because it will stall the whole program, and the whole point of using	795	because it will stall the whole program, and the whole point of using
589	events is to stay interactive.	796	events is to stay interactive.
590		797
591	It is fine, however, to call C<< ->wait >> when the user of your module	798	It is fine, however, to call C<< ->recv >> when the user of your module
592	requests it (i.e. if you create a http request object ad have a method	799	requests it (i.e. if you create a http request object ad have a method
593	called C<results> that returns the results, it should call C<< ->wait >>	800	called C<results> that returns the results, it should call C<< ->recv >>
594	freely, as the user of your module knows what she is doing. always).	801	freely, as the user of your module knows what she is doing. always).
595		802
596	=head1 WHAT TO DO IN THE MAIN PROGRAM	803	=head1 WHAT TO DO IN THE MAIN PROGRAM
597		804
598	There will always be a single main program - the only place that should	805	There will always be a single main program - the only place that should
…		…
600		807
601	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	808	If it doesn't care, it can just "use AnyEvent" and use it itself, or not
602	do anything special (it does not need to be event-based) and let AnyEvent	809	do anything special (it does not need to be event-based) and let AnyEvent
603	decide which implementation to chose if some module relies on it.	810	decide which implementation to chose if some module relies on it.
604		811
605	If the main program relies on a specific event model. For example, in	812	If the main program relies on a specific event model - for example, in
606	Gtk2 programs you have to rely on the Glib module. You should load the	813	Gtk2 programs you have to rely on the Glib module - you should load the
607	event module before loading AnyEvent or any module that uses it: generally	814	event module before loading AnyEvent or any module that uses it: generally
608	speaking, you should load it as early as possible. The reason is that	815	speaking, you should load it as early as possible. The reason is that
609	modules might create watchers when they are loaded, and AnyEvent will	816	modules might create watchers when they are loaded, and AnyEvent will
610	decide on the event model to use as soon as it creates watchers, and it	817	decide on the event model to use as soon as it creates watchers, and it
611	might chose the wrong one unless you load the correct one yourself.	818	might chose the wrong one unless you load the correct one yourself.
612		819
613	You can chose to use a rather inefficient pure-perl implementation by	820	You can chose to use a pure-perl implementation by loading the
614	loading the C<AnyEvent::Impl::Perl> module, which gives you similar	821	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
615	behaviour everywhere, but letting AnyEvent chose is generally better.	822	everywhere, but letting AnyEvent chose the model is generally better.
		823
		824	=head2 MAINLOOP EMULATION
		825
		826	Sometimes (often for short test scripts, or even standalone programs who
		827	only want to use AnyEvent), you do not want to run a specific event loop.
		828
		829	In that case, you can use a condition variable like this:
		830
		831	AnyEvent->condvar->recv;
		832
		833	This has the effect of entering the event loop and looping forever.
		834
		835	Note that usually your program has some exit condition, in which case
		836	it is better to use the "traditional" approach of storing a condition
		837	variable somewhere, waiting for it, and sending it when the program should
		838	exit cleanly.
		839
616		840
617	=head1 OTHER MODULES	841	=head1 OTHER MODULES
618		842
619	The following is a non-exhaustive list of additional modules that use	843	The following is a non-exhaustive list of additional modules that use
620	AnyEvent and can therefore be mixed easily with other AnyEvent modules	844	AnyEvent and can therefore be mixed easily with other AnyEvent modules
…		…
626	=item L<AnyEvent::Util>	850	=item L<AnyEvent::Util>
627		851
628	Contains various utility functions that replace often-used but blocking	852	Contains various utility functions that replace often-used but blocking
629	functions such as C<inet_aton> by event-/callback-based versions.	853	functions such as C<inet_aton> by event-/callback-based versions.
630		854
		855	=item L<AnyEvent::Socket>
		856
		857	Provides various utility functions for (internet protocol) sockets,
		858	addresses and name resolution. Also functions to create non-blocking tcp
		859	connections or tcp servers, with IPv6 and SRV record support and more.
		860
631	=item L<AnyEvent::Handle>	861	=item L<AnyEvent::Handle>
632		862
633	Provide read and write buffers and manages watchers for reads and writes.	863	Provide read and write buffers, manages watchers for reads and writes,
		864	supports raw and formatted I/O, I/O queued and fully transparent and
		865	non-blocking SSL/TLS.
634		866
635	=item L<AnyEvent::Socket>	867	=item L<AnyEvent::DNS>
636		868
637	Provides a means to do non-blocking connects, accepts etc.	869	Provides rich asynchronous DNS resolver capabilities.
		870
		871	=item L<AnyEvent::HTTP>
		872
		873	A simple-to-use HTTP library that is capable of making a lot of concurrent
		874	HTTP requests.
638		875
639	=item L<AnyEvent::HTTPD>	876	=item L<AnyEvent::HTTPD>
640		877
641	Provides a simple web application server framework.	878	Provides a simple web application server framework.
642		879
643	=item L<AnyEvent::DNS>
644
645	Provides asynchronous DNS resolver capabilities, beyond what
646	L<AnyEvent::Util> offers.
647
648	=item L<AnyEvent::FastPing>	880	=item L<AnyEvent::FastPing>
649		881
650	The fastest ping in the west.	882	The fastest ping in the west.
651		883
		884	=item L<AnyEvent::DBI>
		885
		886	Executes L<DBI> requests asynchronously in a proxy process.
		887
		888	=item L<AnyEvent::AIO>
		889
		890	Truly asynchronous I/O, should be in the toolbox of every event
		891	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
		892	together.
		893
		894	=item L<AnyEvent::BDB>
		895
		896	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
		897	L<BDB> and AnyEvent together.
		898
		899	=item L<AnyEvent::GPSD>
		900
		901	A non-blocking interface to gpsd, a daemon delivering GPS information.
		902
		903	=item L<AnyEvent::IGS>
		904
		905	A non-blocking interface to the Internet Go Server protocol (used by
		906	L<App::IGS>).
		907
652	=item L<Net::IRC3>	908	=item L<AnyEvent::IRC>
653		909
654	AnyEvent based IRC client module family.	910	AnyEvent based IRC client module family (replacing the older Net::IRC3).
655		911
656	=item L<Net::XMPP2>	912	=item L<Net::XMPP2>
657		913
658	AnyEvent based XMPP (Jabber protocol) module family.	914	AnyEvent based XMPP (Jabber protocol) module family.
659		915
…		…
672		928
673	=item L<IO::Lambda>	929	=item L<IO::Lambda>
674		930
675	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.	931	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
676		932
677	=item L<IO::AIO>
678
679	Truly asynchronous I/O, should be in the toolbox of every event
680	programmer. Can be trivially made to use AnyEvent.
681
682	=item L<BDB>
683
684	Truly asynchronous Berkeley DB access. Can be trivially made to use
685	AnyEvent.
686
687	=back	933	=back
688		934
689	=cut	935	=cut
690		936
691	package AnyEvent;	937	package AnyEvent;
692		938
693	no warnings;	939	no warnings;
694	use strict;	940	use strict qw(vars subs);
695		941
696	use Carp;	942	use Carp;
697		943
698	our $VERSION = '3.4';	944	our $VERSION = 4.412;
699	our $MODEL;	945	our $MODEL;
700		946
701	our $AUTOLOAD;	947	our $AUTOLOAD;
702	our @ISA;	948	our @ISA;
703		949
		950	our @REGISTRY;
		951
		952	our $WIN32;
		953
		954	BEGIN {
		955	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
		956	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
		957
		958	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		959	if ${^TAINT};
		960	}
		961
704	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	962	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
705		963
706	our @REGISTRY;	964	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
		965
		966	{
		967	my $idx;
		968	$PROTOCOL{$_} = ++$idx
		969	for reverse split /\s*,\s*/,
		970	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
		971	}
707		972
708	my @models = (	973	my @models = (
709	[EV:: => AnyEvent::Impl::EV::],	974	[EV:: => AnyEvent::Impl::EV::],
710	[Event:: => AnyEvent::Impl::Event::],	975	[Event:: => AnyEvent::Impl::Event::],
711	[Tk:: => AnyEvent::Impl::Tk::],
712	[Wx:: => AnyEvent::Impl::POE::],
713	[Prima:: => AnyEvent::Impl::POE::],
714	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	976	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
715	# everything below here will not be autoprobed as the pureperl backend should work everywhere	977	# everything below here will not be autoprobed
716	[Glib:: => AnyEvent::Impl::Glib::],	978	# as the pureperl backend should work everywhere
		979	# and is usually faster
		980	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		981	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
717	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	982	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
718	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	983	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
719	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	984	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
		985	[Wx:: => AnyEvent::Impl::POE::],
		986	[Prima:: => AnyEvent::Impl::POE::],
		987	# IO::Async is just too broken - we would need workaorunds for its
		988	# byzantine signal and broken child handling, among others.
		989	# IO::Async is rather hard to detect, as it doesn't have any
		990	# obvious default class.
		991	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		992	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		993	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
720	);	994	);
721		995
722	our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);	996	our %method = map +($_ => 1),
		997	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
723		998
724	our @post_detect;	999	our @post_detect;
725		1000
726	sub post_detect(&) {	1001	sub post_detect(&) {
727	my ($cb) = @_;	1002	my ($cb) = @_;
…		…
732	1	1007	1
733	} else {	1008	} else {
734	push @post_detect, $cb;	1009	push @post_detect, $cb;
735		1010
736	defined wantarray	1011	defined wantarray
737	? bless \$cb, "AnyEvent::Util::Guard"	1012	? bless \$cb, "AnyEvent::Util::postdetect"
738	: ()	1013	: ()
739	}	1014	}
740	}	1015	}
741		1016
742	sub AnyEvent::Util::Guard::DESTROY {	1017	sub AnyEvent::Util::postdetect::DESTROY {
743	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1018	@post_detect = grep $_ != ${$_[0]}, @post_detect;
744	}	1019	}
745		1020
746	sub detect() {	1021	sub detect() {
747	unless ($MODEL) {	1022	unless ($MODEL) {
748	no strict 'refs';	1023	no strict 'refs';
		1024	local $SIG{__DIE__};
749		1025
750	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1026	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
751	my $model = "AnyEvent::Impl::$1";	1027	my $model = "AnyEvent::Impl::$1";
752	if (eval "require $model") {	1028	if (eval "require $model") {
753	$MODEL = $model;	1029	$MODEL = $model;
…		…
783	last;	1059	last;
784	}	1060	}
785	}	1061	}
786		1062
787	$MODEL	1063	$MODEL
788	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1064	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
789	}	1065	}
790	}	1066	}
791		1067
		1068	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1069
792	unshift @ISA, $MODEL;	1070	unshift @ISA, $MODEL;
793	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1071
		1072	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
794		1073
795	(shift @post_detect)->() while @post_detect;	1074	(shift @post_detect)->() while @post_detect;
796	}	1075	}
797		1076
798	$MODEL	1077	$MODEL
…		…
808		1087
809	my $class = shift;	1088	my $class = shift;
810	$class->$func (@_);	1089	$class->$func (@_);
811	}	1090	}
812		1091
		1092	# utility function to dup a filehandle. this is used by many backends
		1093	# to support binding more than one watcher per filehandle (they usually
		1094	# allow only one watcher per fd, so we dup it to get a different one).
		1095	sub _dupfh($$;$$) {
		1096	my ($poll, $fh, $r, $w) = @_;
		1097
		1098	# cygwin requires the fh mode to be matching, unix doesn't
		1099	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
		1100	: $poll eq "w" ? ($w, ">")
		1101	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
		1102
		1103	open my $fh2, "$mode&" . fileno $fh
		1104	or die "cannot dup() filehandle: $!,";
		1105
		1106	# we assume CLOEXEC is already set by perl in all important cases
		1107
		1108	($fh2, $rw)
		1109	}
		1110
813	package AnyEvent::Base;	1111	package AnyEvent::Base;
814		1112
		1113	# default implementations for many methods
		1114
		1115	BEGIN {
		1116	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1117	*_time = \&Time::HiRes::time;
		1118	# if (eval "use POSIX (); (POSIX::times())...
		1119	} else {
		1120	*_time = sub { time }; # epic fail
		1121	}
		1122	}
		1123
		1124	sub time { _time }
		1125	sub now { _time }
		1126	sub now_update { }
		1127
815	# default implementation for ->condvar, ->wait, ->broadcast	1128	# default implementation for ->condvar
816		1129
817	sub condvar {	1130	sub condvar {
818	bless \my $flag, "AnyEvent::Base::CondVar"	1131	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
819	}
820
821	sub AnyEvent::Base::CondVar::broadcast {
822	${$_[0]}++;
823	}
824
825	sub AnyEvent::Base::CondVar::wait {
826	AnyEvent->one_event while !${$_[0]};
827	}	1132	}
828		1133
829	# default implementation for ->signal	1134	# default implementation for ->signal
830		1135
831	our %SIG_CB;	1136	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1137
		1138	sub _signal_exec {
		1139	sysread $SIGPIPE_R, my $dummy, 4;
		1140
		1141	while (%SIG_EV) {
		1142	for (keys %SIG_EV) {
		1143	delete $SIG_EV{$_};
		1144	$_->() for values %{ $SIG_CB{$_} || {} };
		1145	}
		1146	}
		1147	}
832		1148
833	sub signal {	1149	sub signal {
834	my (undef, %arg) = @_;	1150	my (undef, %arg) = @_;
835		1151
		1152	unless ($SIGPIPE_R) {
		1153	require Fcntl;
		1154
		1155	if (AnyEvent::WIN32) {
		1156	require AnyEvent::Util;
		1157
		1158	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1159	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1160	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1161	} else {
		1162	pipe $SIGPIPE_R, $SIGPIPE_W;
		1163	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1164	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1165
		1166	# not strictly required, as $^F is normally 2, but let's make sure...
		1167	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1168	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1169	}
		1170
		1171	$SIGPIPE_R
		1172	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1173
		1174	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1175	}
		1176
836	my $signal = uc $arg{signal}	1177	my $signal = uc $arg{signal}
837	or Carp::croak "required option 'signal' is missing";	1178	or Carp::croak "required option 'signal' is missing";
838		1179
839	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1180	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
840	$SIG{$signal} ||= sub {	1181	$SIG{$signal} ||= sub {
841	$_->() for values %{ $SIG_CB{$signal} || {} };	1182	local $!;
		1183	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1184	undef $SIG_EV{$signal};
842	};	1185	};
843		1186
844	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1187	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
845	}	1188	}
846		1189
847	sub AnyEvent::Base::Signal::DESTROY {	1190	sub AnyEvent::Base::signal::DESTROY {
848	my ($signal, $cb) = @{$_[0]};	1191	my ($signal, $cb) = @{$_[0]};
849		1192
850	delete $SIG_CB{$signal}{$cb};	1193	delete $SIG_CB{$signal}{$cb};
851		1194
		1195	# delete doesn't work with older perls - they then
		1196	# print weird messages, or just unconditionally exit
		1197	# instead of getting the default action.
852	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };	1198	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
853	}	1199	}
854		1200
855	# default implementation for ->child	1201	# default implementation for ->child
856		1202
857	our %PID_CB;	1203	our %PID_CB;
858	our $CHLD_W;	1204	our $CHLD_W;
859	our $CHLD_DELAY_W;	1205	our $CHLD_DELAY_W;
860	our $PID_IDLE;
861	our $WNOHANG;	1206	our $WNOHANG;
862		1207
863	sub _child_wait {	1208	sub _sigchld {
864	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1209	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
865	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1210	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
866	(values %{ $PID_CB{0} || {} });	1211	(values %{ $PID_CB{0} || {} });
867	}	1212	}
868
869	undef $PID_IDLE;
870	}
871
872	sub _sigchld {
873	# make sure we deliver these changes "synchronous" with the event loop.
874	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
875	undef $CHLD_DELAY_W;
876	&_child_wait;
877	});
878	}	1213	}
879		1214
880	sub child {	1215	sub child {
881	my (undef, %arg) = @_;	1216	my (undef, %arg) = @_;
882		1217
883	defined (my $pid = $arg{pid} + 0)	1218	defined (my $pid = $arg{pid} + 0)
884	or Carp::croak "required option 'pid' is missing";	1219	or Carp::croak "required option 'pid' is missing";
885		1220
886	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1221	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
887		1222
888	unless ($WNOHANG) {
889	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1;	1223	$WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
890	}
891		1224
892	unless ($CHLD_W) {	1225	unless ($CHLD_W) {
893	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1226	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
894	# child could be a zombie already, so make at least one round	1227	# child could be a zombie already, so make at least one round
895	&_sigchld;	1228	&_sigchld;
896	}	1229	}
897		1230
898	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1231	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
899	}	1232	}
900		1233
901	sub AnyEvent::Base::Child::DESTROY {	1234	sub AnyEvent::Base::child::DESTROY {
902	my ($pid, $cb) = @{$_[0]};	1235	my ($pid, $cb) = @{$_[0]};
903		1236
904	delete $PID_CB{$pid}{$cb};	1237	delete $PID_CB{$pid}{$cb};
905	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1238	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
906		1239
907	undef $CHLD_W unless keys %PID_CB;	1240	undef $CHLD_W unless keys %PID_CB;
908	}	1241	}
		1242
		1243	# idle emulation is done by simply using a timer, regardless
		1244	# of whether the process is idle or not, and not letting
		1245	# the callback use more than 50% of the time.
		1246	sub idle {
		1247	my (undef, %arg) = @_;
		1248
		1249	my ($cb, $w, $rcb) = $arg{cb};
		1250
		1251	$rcb = sub {
		1252	if ($cb) {
		1253	$w = _time;
		1254	&$cb;
		1255	$w = _time - $w;
		1256
		1257	# never use more then 50% of the time for the idle watcher,
		1258	# within some limits
		1259	$w = 0.0001 if $w < 0.0001;
		1260	$w = 5 if $w > 5;
		1261
		1262	$w = AnyEvent->timer (after => $w, cb => $rcb);
		1263	} else {
		1264	# clean up...
		1265	undef $w;
		1266	undef $rcb;
		1267	}
		1268	};
		1269
		1270	$w = AnyEvent->timer (after => 0.05, cb => $rcb);
		1271
		1272	bless \\$cb, "AnyEvent::Base::idle"
		1273	}
		1274
		1275	sub AnyEvent::Base::idle::DESTROY {
		1276	undef $${$_[0]};
		1277	}
		1278
		1279	package AnyEvent::CondVar;
		1280
		1281	our @ISA = AnyEvent::CondVar::Base::;
		1282
		1283	package AnyEvent::CondVar::Base;
		1284
		1285	use overload
		1286	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		1287	fallback => 1;
		1288
		1289	sub _send {
		1290	# nop
		1291	}
		1292
		1293	sub send {
		1294	my $cv = shift;
		1295	$cv->{_ae_sent} = [@_];
		1296	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
		1297	$cv->_send;
		1298	}
		1299
		1300	sub croak {
		1301	$_[0]{_ae_croak} = $_[1];
		1302	$_[0]->send;
		1303	}
		1304
		1305	sub ready {
		1306	$_[0]{_ae_sent}
		1307	}
		1308
		1309	sub _wait {
		1310	AnyEvent->one_event while !$_[0]{_ae_sent};
		1311	}
		1312
		1313	sub recv {
		1314	$_[0]->_wait;
		1315
		1316	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
		1317	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
		1318	}
		1319
		1320	sub cb {
		1321	$_[0]{_ae_cb} = $_[1] if @_ > 1;
		1322	$_[0]{_ae_cb}
		1323	}
		1324
		1325	sub begin {
		1326	++$_[0]{_ae_counter};
		1327	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
		1328	}
		1329
		1330	sub end {
		1331	return if --$_[0]{_ae_counter};
		1332	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
		1333	}
		1334
		1335	# undocumented/compatibility with pre-3.4
		1336	*broadcast = \&send;
		1337	*wait = \&_wait;
		1338
		1339	=head1 ERROR AND EXCEPTION HANDLING
		1340
		1341	In general, AnyEvent does not do any error handling - it relies on the
		1342	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1343	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1344	checking of all AnyEvent methods, however, which is highly useful during
		1345	development.
		1346
		1347	As for exception handling (i.e. runtime errors and exceptions thrown while
		1348	executing a callback), this is not only highly event-loop specific, but
		1349	also not in any way wrapped by this module, as this is the job of the main
		1350	program.
		1351
		1352	The pure perl event loop simply re-throws the exception (usually
		1353	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1354	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1355	so on.
		1356
		1357	=head1 ENVIRONMENT VARIABLES
		1358
		1359	The following environment variables are used by this module or its
		1360	submodules.
		1361
		1362	Note that AnyEvent will remove I<all> environment variables starting with
		1363	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1364	enabled.
		1365
		1366	=over 4
		1367
		1368	=item C<PERL_ANYEVENT_VERBOSE>
		1369
		1370	By default, AnyEvent will be completely silent except in fatal
		1371	conditions. You can set this environment variable to make AnyEvent more
		1372	talkative.
		1373
		1374	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1375	conditions, such as not being able to load the event model specified by
		1376	C<PERL_ANYEVENT_MODEL>.
		1377
		1378	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1379	model it chooses.
		1380
		1381	=item C<PERL_ANYEVENT_STRICT>
		1382
		1383	AnyEvent does not do much argument checking by default, as thorough
		1384	argument checking is very costly. Setting this variable to a true value
		1385	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1386	check the arguments passed to most method calls. If it finds any problems,
		1387	it will croak.
		1388
		1389	In other words, enables "strict" mode.
		1390
		1391	Unlike C<use strict>, it is definitely recommended to keep it off in
		1392	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
		1393	developing programs can be very useful, however.
		1394
		1395	=item C<PERL_ANYEVENT_MODEL>
		1396
		1397	This can be used to specify the event model to be used by AnyEvent, before
		1398	auto detection and -probing kicks in. It must be a string consisting
		1399	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1400	and the resulting module name is loaded and if the load was successful,
		1401	used as event model. If it fails to load AnyEvent will proceed with
		1402	auto detection and -probing.
		1403
		1404	This functionality might change in future versions.
		1405
		1406	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1407	could start your program like this:
		1408
		1409	PERL_ANYEVENT_MODEL=Perl perl ...
		1410
		1411	=item C<PERL_ANYEVENT_PROTOCOLS>
		1412
		1413	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1414	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1415	of auto probing).
		1416
		1417	Must be set to a comma-separated list of protocols or address families,
		1418	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1419	used, and preference will be given to protocols mentioned earlier in the
		1420	list.
		1421
		1422	This variable can effectively be used for denial-of-service attacks
		1423	against local programs (e.g. when setuid), although the impact is likely
		1424	small, as the program has to handle conenction and other failures anyways.
		1425
		1426	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1427	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1428	- only support IPv4, never try to resolve or contact IPv6
		1429	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1430	IPv6, but prefer IPv6 over IPv4.
		1431
		1432	=item C<PERL_ANYEVENT_EDNS0>
		1433
		1434	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1435	for DNS. This extension is generally useful to reduce DNS traffic, but
		1436	some (broken) firewalls drop such DNS packets, which is why it is off by
		1437	default.
		1438
		1439	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1440	EDNS0 in its DNS requests.
		1441
		1442	=item C<PERL_ANYEVENT_MAX_FORKS>
		1443
		1444	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1445	will create in parallel.
		1446
		1447	=back
909		1448
910	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1449	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
911		1450
912	This is an advanced topic that you do not normally need to use AnyEvent in	1451	This is an advanced topic that you do not normally need to use AnyEvent in
913	a module. This section is only of use to event loop authors who want to	1452	a module. This section is only of use to event loop authors who want to
…		…
947		1486
948	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1487	I<rxvt-unicode> also cheats a bit by not providing blocking access to
949	condition variables: code blocking while waiting for a condition will	1488	condition variables: code blocking while waiting for a condition will
950	C<die>. This still works with most modules/usages, and blocking calls must	1489	C<die>. This still works with most modules/usages, and blocking calls must
951	not be done in an interactive application, so it makes sense.	1490	not be done in an interactive application, so it makes sense.
952
953	=head1 ENVIRONMENT VARIABLES
954
955	The following environment variables are used by this module:
956
957	=over 4
958
959	=item C<PERL_ANYEVENT_VERBOSE>
960
961	By default, AnyEvent will be completely silent except in fatal
962	conditions. You can set this environment variable to make AnyEvent more
963	talkative.
964
965	When set to C<1> or higher, causes AnyEvent to warn about unexpected
966	conditions, such as not being able to load the event model specified by
967	C<PERL_ANYEVENT_MODEL>.
968
969	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
970	model it chooses.
971
972	=item C<PERL_ANYEVENT_MODEL>
973
974	This can be used to specify the event model to be used by AnyEvent, before
975	autodetection and -probing kicks in. It must be a string consisting
976	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
977	and the resulting module name is loaded and if the load was successful,
978	used as event model. If it fails to load AnyEvent will proceed with
979	autodetection and -probing.
980
981	This functionality might change in future versions.
982
983	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
984	could start your program like this:
985
986	PERL_ANYEVENT_MODEL=Perl perl ...
987
988	=back
989		1491
990	=head1 EXAMPLE PROGRAM	1492	=head1 EXAMPLE PROGRAM
991		1493
992	The following program uses an I/O watcher to read data from STDIN, a timer	1494	The following program uses an I/O watcher to read data from STDIN, a timer
993	to display a message once per second, and a condition variable to quit the	1495	to display a message once per second, and a condition variable to quit the
…		…
1002	poll => 'r',	1504	poll => 'r',
1003	cb => sub {	1505	cb => sub {
1004	warn "io event <$_[0]>\n"; # will always output <r>	1506	warn "io event <$_[0]>\n"; # will always output <r>
1005	chomp (my $input = <STDIN>); # read a line	1507	chomp (my $input = <STDIN>); # read a line
1006	warn "read: $input\n"; # output what has been read	1508	warn "read: $input\n"; # output what has been read
1007	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i	1509	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1008	},	1510	},
1009	);	1511	);
1010		1512
1011	my $time_watcher; # can only be used once	1513	my $time_watcher; # can only be used once
1012		1514
…		…
1017	});	1519	});
1018	}	1520	}
1019		1521
1020	new_timer; # create first timer	1522	new_timer; # create first timer
1021		1523
1022	$cv->wait; # wait until user enters /^q/i	1524	$cv->recv; # wait until user enters /^q/i
1023		1525
1024	=head1 REAL-WORLD EXAMPLE	1526	=head1 REAL-WORLD EXAMPLE
1025		1527
1026	Consider the L<Net::FCP> module. It features (among others) the following	1528	Consider the L<Net::FCP> module. It features (among others) the following
1027	API calls, which are to freenet what HTTP GET requests are to http:	1529	API calls, which are to freenet what HTTP GET requests are to http:
…		…
1077	syswrite $txn->{fh}, $txn->{request}	1579	syswrite $txn->{fh}, $txn->{request}
1078	or die "connection or write error";	1580	or die "connection or write error";
1079	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	1581	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1080		1582
1081	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	1583	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1082	result and signals any possible waiters that the request ahs finished:	1584	result and signals any possible waiters that the request has finished:
1083		1585
1084	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	1586	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1085		1587
1086	if (end-of-file or data complete) {	1588	if (end-of-file or data complete) {
1087	$txn->{result} = $txn->{buf};	1589	$txn->{result} = $txn->{buf};
1088	$txn->{finished}->broadcast;	1590	$txn->{finished}->send;
1089	$txb->{cb}->($txn) of $txn->{cb}; # also call callback	1591	$txb->{cb}->($txn) of $txn->{cb}; # also call callback
1090	}	1592	}
1091		1593
1092	The C<result> method, finally, just waits for the finished signal (if the	1594	The C<result> method, finally, just waits for the finished signal (if the
1093	request was already finished, it doesn't wait, of course, and returns the	1595	request was already finished, it doesn't wait, of course, and returns the
1094	data:	1596	data:
1095		1597
1096	$txn->{finished}->wait;	1598	$txn->{finished}->recv;
1097	return $txn->{result};	1599	return $txn->{result};
1098		1600
1099	The actual code goes further and collects all errors (C<die>s, exceptions)	1601	The actual code goes further and collects all errors (C<die>s, exceptions)
1100	that occured during request processing. The C<result> method detects	1602	that occurred during request processing. The C<result> method detects
1101	whether an exception as thrown (it is stored inside the $txn object)	1603	whether an exception as thrown (it is stored inside the $txn object)
1102	and just throws the exception, which means connection errors and other	1604	and just throws the exception, which means connection errors and other
1103	problems get reported tot he code that tries to use the result, not in a	1605	problems get reported tot he code that tries to use the result, not in a
1104	random callback.	1606	random callback.
1105		1607
…		…
1136		1638
1137	my $quit = AnyEvent->condvar;	1639	my $quit = AnyEvent->condvar;
1138		1640
1139	$fcp->txn_client_get ($url)->cb (sub {	1641	$fcp->txn_client_get ($url)->cb (sub {
1140	...	1642	...
1141	$quit->broadcast;	1643	$quit->send;
1142	});	1644	});
1143		1645
1144	$quit->wait;	1646	$quit->recv;
1145		1647
1146		1648
1147	=head1 BENCHMARKS	1649	=head1 BENCHMARKS
1148		1650
1149	To give you an idea of the performance and overheads that AnyEvent adds	1651	To give you an idea of the performance and overheads that AnyEvent adds
…		…
1151	of various event loops I prepared some benchmarks.	1653	of various event loops I prepared some benchmarks.
1152		1654
1153	=head2 BENCHMARKING ANYEVENT OVERHEAD	1655	=head2 BENCHMARKING ANYEVENT OVERHEAD
1154		1656
1155	Here is a benchmark of various supported event models used natively and	1657	Here is a benchmark of various supported event models used natively and
1156	through anyevent. The benchmark creates a lot of timers (with a zero	1658	through AnyEvent. The benchmark creates a lot of timers (with a zero
1157	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	1659	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1158	which it is), lets them fire exactly once and destroys them again.	1660	which it is), lets them fire exactly once and destroys them again.
1159		1661
1160	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	1662	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1161	distribution.	1663	distribution.
…		…
1178	all watchers, to avoid adding memory overhead. That means closure creation	1680	all watchers, to avoid adding memory overhead. That means closure creation
1179	and memory usage is not included in the figures.	1681	and memory usage is not included in the figures.
1180		1682
1181	I<invoke> is the time, in microseconds, used to invoke a simple	1683	I<invoke> is the time, in microseconds, used to invoke a simple
1182	callback. The callback simply counts down a Perl variable and after it was	1684	callback. The callback simply counts down a Perl variable and after it was
1183	invoked "watcher" times, it would C<< ->broadcast >> a condvar once to	1685	invoked "watcher" times, it would C<< ->send >> a condvar once to
1184	signal the end of this phase.	1686	signal the end of this phase.
1185		1687
1186	I<destroy> is the time, in microseconds, that it takes to destroy a single	1688	I<destroy> is the time, in microseconds, that it takes to destroy a single
1187	watcher.	1689	watcher.
1188		1690
1189	=head3 Results	1691	=head3 Results
1190		1692
1191	name watchers bytes create invoke destroy comment	1693	name watchers bytes create invoke destroy comment
1192	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1694	EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1193	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	1695	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1194	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	1696	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1195	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	1697	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1196	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	1698	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1197	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	1699	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1198	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	1700	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1199	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	1701	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1200	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	1702	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1201	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	1703	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1202		1704
1203	=head3 Discussion	1705	=head3 Discussion
1204		1706
1205	The benchmark does I<not> measure scalability of the event loop very	1707	The benchmark does I<not> measure scalability of the event loop very
1206	well. For example, a select-based event loop (such as the pure perl one)	1708	well. For example, a select-based event loop (such as the pure perl one)
…		…
1284		1786
1285	=back	1787	=back
1286		1788
1287	=head2 BENCHMARKING THE LARGE SERVER CASE	1789	=head2 BENCHMARKING THE LARGE SERVER CASE
1288		1790
1289	This benchmark atcually benchmarks the event loop itself. It works by	1791	This benchmark actually benchmarks the event loop itself. It works by
1290	creating a number of "servers": each server consists of a socketpair, a	1792	creating a number of "servers": each server consists of a socket pair, a
1291	timeout watcher that gets reset on activity (but never fires), and an I/O	1793	timeout watcher that gets reset on activity (but never fires), and an I/O
1292	watcher waiting for input on one side of the socket. Each time the socket	1794	watcher waiting for input on one side of the socket. Each time the socket
1293	watcher reads a byte it will write that byte to a random other "server".	1795	watcher reads a byte it will write that byte to a random other "server".
1294		1796
1295	The effect is that there will be a lot of I/O watchers, only part of which	1797	The effect is that there will be a lot of I/O watchers, only part of which
1296	are active at any one point (so there is a constant number of active	1798	are active at any one point (so there is a constant number of active
1297	fds for each loop iterstaion, but which fds these are is random). The	1799	fds for each loop iteration, but which fds these are is random). The
1298	timeout is reset each time something is read because that reflects how	1800	timeout is reset each time something is read because that reflects how
1299	most timeouts work (and puts extra pressure on the event loops).	1801	most timeouts work (and puts extra pressure on the event loops).
1300		1802
1301	In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100	1803	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1302	(1%) are active. This mirrors the activity of large servers with many	1804	(1%) are active. This mirrors the activity of large servers with many
1303	connections, most of which are idle at any one point in time.	1805	connections, most of which are idle at any one point in time.
1304		1806
1305	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	1807	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1306	distribution.	1808	distribution.
…		…
1308	=head3 Explanation of the columns	1810	=head3 Explanation of the columns
1309		1811
1310	I<sockets> is the number of sockets, and twice the number of "servers" (as	1812	I<sockets> is the number of sockets, and twice the number of "servers" (as
1311	each server has a read and write socket end).	1813	each server has a read and write socket end).
1312		1814
1313	I<create> is the time it takes to create a socketpair (which is	1815	I<create> is the time it takes to create a socket pair (which is
1314	nontrivial) and two watchers: an I/O watcher and a timeout watcher.	1816	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1315		1817
1316	I<request>, the most important value, is the time it takes to handle a	1818	I<request>, the most important value, is the time it takes to handle a
1317	single "request", that is, reading the token from the pipe and forwarding	1819	single "request", that is, reading the token from the pipe and forwarding
1318	it to another server. This includes deleting the old timeout and creating	1820	it to another server. This includes deleting the old timeout and creating
…		…
1391	speed most when you have lots of watchers, not when you only have a few of	1893	speed most when you have lots of watchers, not when you only have a few of
1392	them).	1894	them).
1393		1895
1394	EV is again fastest.	1896	EV is again fastest.
1395		1897
1396	Perl again comes second. It is noticably faster than the C-based event	1898	Perl again comes second. It is noticeably faster than the C-based event
1397	loops Event and Glib, although the difference is too small to really	1899	loops Event and Glib, although the difference is too small to really
1398	matter.	1900	matter.
1399		1901
1400	POE also performs much better in this case, but is is still far behind the	1902	POE also performs much better in this case, but is is still far behind the
1401	others.	1903	others.
…		…
1407	=item * C-based event loops perform very well with small number of	1909	=item * C-based event loops perform very well with small number of
1408	watchers, as the management overhead dominates.	1910	watchers, as the management overhead dominates.
1409		1911
1410	=back	1912	=back
1411		1913
		1914	=head2 THE IO::Lambda BENCHMARK
		1915
		1916	Recently I was told about the benchmark in the IO::Lambda manpage, which
		1917	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		1918	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		1919	shouldn't come as a surprise to anybody). As such, the benchmark is
		1920	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		1921	very optimal. But how would AnyEvent compare when used without the extra
		1922	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		1923
		1924	The benchmark itself creates an echo-server, and then, for 500 times,
		1925	connects to the echo server, sends a line, waits for the reply, and then
		1926	creates the next connection. This is a rather bad benchmark, as it doesn't
		1927	test the efficiency of the framework or much non-blocking I/O, but it is a
		1928	benchmark nevertheless.
		1929
		1930	name runtime
		1931	Lambda/select 0.330 sec
		1932	+ optimized 0.122 sec
		1933	Lambda/AnyEvent 0.327 sec
		1934	+ optimized 0.138 sec
		1935	Raw sockets/select 0.077 sec
		1936	POE/select, components 0.662 sec
		1937	POE/select, raw sockets 0.226 sec
		1938	POE/select, optimized 0.404 sec
		1939
		1940	AnyEvent/select/nb 0.085 sec
		1941	AnyEvent/EV/nb 0.068 sec
		1942	+state machine 0.134 sec
		1943
		1944	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		1945	benchmarks actually make blocking connects and use 100% blocking I/O,
		1946	defeating the purpose of an event-based solution. All of the newly
		1947	written AnyEvent benchmarks use 100% non-blocking connects (using
		1948	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		1949	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		1950	generally require a lot more bookkeeping and event handling than blocking
		1951	connects (which involve a single syscall only).
		1952
		1953	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		1954	offers similar expressive power as POE and IO::Lambda, using conventional
		1955	Perl syntax. This means that both the echo server and the client are 100%
		1956	non-blocking, further placing it at a disadvantage.
		1957
		1958	As you can see, the AnyEvent + EV combination even beats the
		1959	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		1960	backend easily beats IO::Lambda and POE.
		1961
		1962	And even the 100% non-blocking version written using the high-level (and
		1963	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
		1964	large margin, even though it does all of DNS, tcp-connect and socket I/O
		1965	in a non-blocking way.
		1966
		1967	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		1968	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		1969	part of the IO::lambda distribution and were used without any changes.
		1970
		1971
		1972	=head1 SIGNALS
		1973
		1974	AnyEvent currently installs handlers for these signals:
		1975
		1976	=over 4
		1977
		1978	=item SIGCHLD
		1979
		1980	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		1981	emulation for event loops that do not support them natively. Also, some
		1982	event loops install a similar handler.
		1983
		1984	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will
		1985	reset it to default, to avoid losing child exit statuses.
		1986
		1987	=item SIGPIPE
		1988
		1989	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		1990	when AnyEvent gets loaded.
		1991
		1992	The rationale for this is that AnyEvent users usually do not really depend
		1993	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		1994	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		1995	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		1996	some random socket.
		1997
		1998	The rationale for installing a no-op handler as opposed to ignoring it is
		1999	that this way, the handler will be restored to defaults on exec.
		2000
		2001	Feel free to install your own handler, or reset it to defaults.
		2002
		2003	=back
		2004
		2005	=cut
		2006
		2007	undef $SIG{CHLD}
		2008	if $SIG{CHLD} eq 'IGNORE';
		2009
		2010	$SIG{PIPE} = sub { }
		2011	unless defined $SIG{PIPE};
1412		2012
1413	=head1 FORK	2013	=head1 FORK
1414		2014
1415	Most event libraries are not fork-safe. The ones who are usually are	2015	Most event libraries are not fork-safe. The ones who are usually are
1416	because they rely on inefficient but fork-safe C<select> or C<poll>	2016	because they rely on inefficient but fork-safe C<select> or C<poll>
…		…
1430	specified in the variable.	2030	specified in the variable.
1431		2031
1432	You can make AnyEvent completely ignore this variable by deleting it	2032	You can make AnyEvent completely ignore this variable by deleting it
1433	before the first watcher gets created, e.g. with a C<BEGIN> block:	2033	before the first watcher gets created, e.g. with a C<BEGIN> block:
1434		2034
1435	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	2035	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1436		2036
1437	use AnyEvent;	2037	use AnyEvent;
1438		2038
1439	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2039	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1440	be used to probe what backend is used and gain other information (which is	2040	be used to probe what backend is used and gain other information (which is
1441	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	2041	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		2042	$ENV{PERL_ANYEVENT_STRICT}.
		2043
		2044	Note that AnyEvent will remove I<all> environment variables starting with
		2045	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2046	enabled.
		2047
		2048
		2049	=head1 BUGS
		2050
		2051	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		2052	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		2053	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		2054	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
		2055	pronounced).
1442		2056
1443		2057
1444	=head1 SEE ALSO	2058	=head1 SEE ALSO
		2059
		2060	Utility functions: L<AnyEvent::Util>.
1445		2061
1446	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2062	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1447	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2063	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1448		2064
1449	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2065	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1450	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2066	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1451	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2067	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1452	L<AnyEvent::Impl::POE>.	2068	L<AnyEvent::Impl::POE>.
1453		2069
		2070	Non-blocking file handles, sockets, TCP clients and
		2071	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
		2072
		2073	Asynchronous DNS: L<AnyEvent::DNS>.
		2074
1454	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2075	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
1455		2076
1456	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.	2077	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1457		2078
1458		2079
1459	=head1 AUTHOR	2080	=head1 AUTHOR
1460		2081
1461	Marc Lehmann <schmorp@schmorp.de>	2082	Marc Lehmann <schmorp@schmorp.de>
1462	http://home.schmorp.de/	2083	http://home.schmorp.de/
1463		2084
1464	=cut	2085	=cut
1465		2086
1466	1	2087	1
1467		2088

Diff Legend

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