[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.134 by root, Sun May 25 04:44:04 2008 UTC vs.
Revision 1.208 by root, Sun Apr 26 18:12:53 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, POE - various supported event loops
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	use AnyEvent;	9	use AnyEvent;
10		10
		11	# file descriptor readable
11	my $w = AnyEvent->io (fh => $fh, poll => "r\|w", cb => sub {	12	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
		13
		14	# one-shot or repeating timers
		15	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
		16	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
		17
		18	print AnyEvent->now; # prints current event loop time
		19	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
		20
		21	# POSIX signal
		22	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
		23
		24	# child process exit
		25	my $w = AnyEvent->child (pid => $pid, cb => sub {
		26	my ($pid, $status) = @_;
12	...	27	...
13	});	28	});
14		29
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	30	# called when event loop idle (if applicable)
16	...	31	my $w = AnyEvent->idle (cb => sub { ... });
17	});
18		32
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	33	my $w = AnyEvent->condvar; # stores whether a condition was flagged
20	$w->send; # wake up current and all future recv's	34	$w->send; # wake up current and all future recv's
21	$w->recv; # enters "main loop" till $condvar gets ->send	35	$w->recv; # enters "main loop" till $condvar gets ->send
		36	# use a condvar in callback mode:
		37	$w->cb (sub { $_[0]->recv });
		38
		39	=head1 INTRODUCTION/TUTORIAL
		40
		41	This manpage is mainly a reference manual. If you are interested
		42	in a tutorial or some gentle introduction, have a look at the
		43	L<AnyEvent::Intro> manpage.
22		44
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	45	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		46
25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	47	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26	nowadays. So what is different about AnyEvent?	48	nowadays. So what is different about AnyEvent?
27		49
28	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	50	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29	policy> and AnyEvent is I<small and efficient>.	51	policy> and AnyEvent is I<small and efficient>.
30		52
31	First and foremost, I<AnyEvent is not an event model> itself, it only	53	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	54	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,	55	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,	56	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	57	only one event loop can be active at the same time in a process. AnyEvent
36	helps hiding the differences between those event loops.	58	cannot change this, but it can hide the differences between those event
		59	loops.
37		60
38	The goal of AnyEvent is to offer module authors the ability to do event	61	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	62	programming (waiting for I/O or timer events) without subscribing to a
40	religion, a way of living, and most importantly: without forcing your	63	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	64	module users into the same thing by forcing them to use the same event
42	model you use.	65	model you use.
43		66
44	For modules like POE or IO::Async (which is a total misnomer as it is	67	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	68	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	69	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	70	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	71	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.	72	module are I<also> forced to use the same event loop you use.
50		73
51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	74	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	75	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	76	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,	77	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	78	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	79	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	80	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).	81	to AnyEvent, too, so it is future-proof).
59		82
60	In addition to being free of having to use I<the one and only true event	83	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	84	model>, AnyEvent also is free of bloat and policy: with POE or similar
62	modules, you get an enormous amount of code and strict rules you have to	85	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	86	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	87	offering the functionality that is necessary, in as thin as a wrapper as
65	technically possible.	88	technically possible.
66		89
		90	Of course, AnyEvent comes with a big (and fully optional!) toolbox
		91	of useful functionality, such as an asynchronous DNS resolver, 100%
		92	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
		93	such as Windows) and lots of real-world knowledge and workarounds for
		94	platform bugs and differences.
		95
67	Of course, if you want lots of policy (this can arguably be somewhat	96	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	97	useful) and you want to force your users to use the one and only event
69	model, you should I<not> use this module.	98	model, you should I<not> use this module.
70		99
71	=head1 DESCRIPTION	100	=head1 DESCRIPTION
72		101
102	starts using it, all bets are off. Maybe you should tell their authors to	131	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...	132	use AnyEvent so their modules work together with others seamlessly...
104		133
105	The pure-perl implementation of AnyEvent is called	134	The pure-perl implementation of AnyEvent is called
106	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	135	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107	explicitly.	136	explicitly and enjoy the high availability of that event loop :)
108		137
109	=head1 WATCHERS	138	=head1 WATCHERS
110		139
111	AnyEvent has the central concept of a I<watcher>, which is an object that	140	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	141	stores relevant data for each kind of event you are waiting for, such as
…		…
115	These watchers are normal Perl objects with normal Perl lifetime. After	144	These watchers are normal Perl objects with normal Perl lifetime. After
116	creating a watcher it will immediately "watch" for events and invoke the	145	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	146	callback when the event occurs (of course, only when the event model
118	is in control).	147	is in control).
119		148
		149	Note that B<callbacks must not permanently change global variables>
		150	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
		151	callbacks must not C<die> >>. The former is good programming practise in
		152	Perl and the latter stems from the fact that exception handling differs
		153	widely between event loops.
		154
120	To disable the watcher you have to destroy it (e.g. by setting the	155	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	156	variable you store it in to C<undef> or otherwise deleting all references
122	to it).	157	to it).
123		158
124	All watchers are created by calling a method on the C<AnyEvent> class.	159	All watchers are created by calling a method on the C<AnyEvent> class.
…		…
126	Many watchers either are used with "recursion" (repeating timers for	161	Many watchers either are used with "recursion" (repeating timers for
127	example), or need to refer to their watcher object in other ways.	162	example), or need to refer to their watcher object in other ways.
128		163
129	An any way to achieve that is this pattern:	164	An any way to achieve that is this pattern:
130		165
131	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	166	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132	# you can use $w here, for example to undef it	167	# you can use $w here, for example to undef it
133	undef $w;	168	undef $w;
134	});	169	});
135		170
136	Note that C<my $w; $w => combination. This is necessary because in Perl,	171	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	172	my variables are only visible after the statement in which they are
138	declared.	173	declared.
139		174
140	=head2 I/O WATCHERS	175	=head2 I/O WATCHERS
141		176
142	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	177	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
143	with the following mandatory key-value pairs as arguments:	178	with the following mandatory key-value pairs as arguments:
144		179
145	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	180	C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
		181	for events (AnyEvent might or might not keep a reference to this file
		182	handle). Note that only file handles pointing to things for which
		183	non-blocking operation makes sense are allowed. This includes sockets,
		184	most character devices, pipes, fifos and so on, but not for example files
		185	or block devices.
		186
146	for events. C<poll> must be a string that is either C<r> or C<w>,	187	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,	188	watcher waiting for "r"eadable or "w"ritable events, respectively.
		189
148	respectively. C<cb> is the callback to invoke each time the file handle	190	C<cb> is the callback to invoke each time the file handle becomes ready.
149	becomes ready.
150		191
151	Although the callback might get passed parameters, their value and	192	Although the callback might get passed parameters, their value and
152	presence is undefined and you cannot rely on them. Portable AnyEvent	193	presence is undefined and you cannot rely on them. Portable AnyEvent
153	callbacks cannot use arguments passed to I/O watcher callbacks.	194	callbacks cannot use arguments passed to I/O watcher callbacks.
154		195
…		…
158		199
159	Some event loops issue spurious readyness notifications, so you should	200	Some event loops issue spurious readyness notifications, so you should
160	always use non-blocking calls when reading/writing from/to your file	201	always use non-blocking calls when reading/writing from/to your file
161	handles.	202	handles.
162		203
163	Example:
164
165	# wait for readability of STDIN, then read a line and disable the watcher	204	Example: wait for readability of STDIN, then read a line and disable the
		205	watcher.
		206
166	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	207	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167	chomp (my $input = <STDIN>);	208	chomp (my $input = <STDIN>);
168	warn "read: $input\n";	209	warn "read: $input\n";
169	undef $w;	210	undef $w;
170	});	211	});
…		…
180		221
181	Although the callback might get passed parameters, their value and	222	Although the callback might get passed parameters, their value and
182	presence is undefined and you cannot rely on them. Portable AnyEvent	223	presence is undefined and you cannot rely on them. Portable AnyEvent
183	callbacks cannot use arguments passed to time watcher callbacks.	224	callbacks cannot use arguments passed to time watcher callbacks.
184		225
185	The timer callback will be invoked at most once: if you want a repeating	226	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	227	parameter, C<interval>, as a strictly positive number (> 0), then the
187	and Glib).	228	callback will be invoked regularly at that interval (in fractional
		229	seconds) after the first invocation. If C<interval> is specified with a
		230	false value, then it is treated as if it were missing.
188		231
189	Example:	232	The callback will be rescheduled before invoking the callback, but no
		233	attempt is done to avoid timer drift in most backends, so the interval is
		234	only approximate.
190		235
191	# fire an event after 7.7 seconds	236	Example: fire an event after 7.7 seconds.
		237
192	my $w = AnyEvent->timer (after => 7.7, cb => sub {	238	my $w = AnyEvent->timer (after => 7.7, cb => sub {
193	warn "timeout\n";	239	warn "timeout\n";
194	});	240	});
195		241
196	# to cancel the timer:	242	# to cancel the timer:
197	undef $w;	243	undef $w;
198		244
199	Example 2:
200
201	# fire an event after 0.5 seconds, then roughly every second	245	Example 2: fire an event after 0.5 seconds, then roughly every second.
202	my $w;
203		246
204	my $cb = sub {
205	# cancel the old timer while creating a new one
206	$w = AnyEvent->timer (after => 1, cb => $cb);	247	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		248	warn "timeout\n";
207	};	249	};
208
209	# start the "loop" by creating the first watcher
210	$w = AnyEvent->timer (after => 0.5, cb => $cb);
211		250
212	=head3 TIMING ISSUES	251	=head3 TIMING ISSUES
213		252
214	There are two ways to handle timers: based on real time (relative, "fire	253	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	254	in 10 seconds") and based on wallclock time (absolute, "fire at 12
…		…
227	timers.	266	timers.
228		267
229	AnyEvent always prefers relative timers, if available, matching the	268	AnyEvent always prefers relative timers, if available, matching the
230	AnyEvent API.	269	AnyEvent API.
231		270
		271	AnyEvent has two additional methods that return the "current time":
		272
		273	=over 4
		274
		275	=item AnyEvent->time
		276
		277	This returns the "current wallclock time" as a fractional number of
		278	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
		279	return, and the result is guaranteed to be compatible with those).
		280
		281	It progresses independently of any event loop processing, i.e. each call
		282	will check the system clock, which usually gets updated frequently.
		283
		284	=item AnyEvent->now
		285
		286	This also returns the "current wallclock time", but unlike C<time>, above,
		287	this value might change only once per event loop iteration, depending on
		288	the event loop (most return the same time as C<time>, above). This is the
		289	time that AnyEvent's timers get scheduled against.
		290
		291	I<In almost all cases (in all cases if you don't care), this is the
		292	function to call when you want to know the current time.>
		293
		294	This function is also often faster then C<< AnyEvent->time >>, and
		295	thus the preferred method if you want some timestamp (for example,
		296	L<AnyEvent::Handle> uses this to update it's activity timeouts).
		297
		298	The rest of this section is only of relevance if you try to be very exact
		299	with your timing, you can skip it without bad conscience.
		300
		301	For a practical example of when these times differ, consider L<Event::Lib>
		302	and L<EV> and the following set-up:
		303
		304	The event loop is running and has just invoked one of your callback at
		305	time=500 (assume no other callbacks delay processing). In your callback,
		306	you wait a second by executing C<sleep 1> (blocking the process for a
		307	second) and then (at time=501) you create a relative timer that fires
		308	after three seconds.
		309
		310	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
		311	both return C<501>, because that is the current time, and the timer will
		312	be scheduled to fire at time=504 (C<501> + C<3>).
		313
		314	With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
		315	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
		316	last event processing phase started. With L<EV>, your timer gets scheduled
		317	to run at time=503 (C<500> + C<3>).
		318
		319	In one sense, L<Event::Lib> is more exact, as it uses the current time
		320	regardless of any delays introduced by event processing. However, most
		321	callbacks do not expect large delays in processing, so this causes a
		322	higher drift (and a lot more system calls to get the current time).
		323
		324	In another sense, L<EV> is more exact, as your timer will be scheduled at
		325	the same time, regardless of how long event processing actually took.
		326
		327	In either case, if you care (and in most cases, you don't), then you
		328	can get whatever behaviour you want with any event loop, by taking the
		329	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
		330	account.
		331
		332	=item AnyEvent->now_update
		333
		334	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
		335	the current time for each loop iteration (see the discussion of L<<
		336	AnyEvent->now >>, above).
		337
		338	When a callback runs for a long time (or when the process sleeps), then
		339	this "current" time will differ substantially from the real time, which
		340	might affect timers and time-outs.
		341
		342	When this is the case, you can call this method, which will update the
		343	event loop's idea of "current time".
		344
		345	Note that updating the time I<might> cause some events to be handled.
		346
		347	=back
		348
232	=head2 SIGNAL WATCHERS	349	=head2 SIGNAL WATCHERS
233		350
234	You can watch for signals using a signal watcher, C<signal> is the signal	351	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	352	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236	be invoked whenever a signal occurs.	353	callback to be invoked whenever a signal occurs.
237		354
238	Although the callback might get passed parameters, their value and	355	Although the callback might get passed parameters, their value and
239	presence is undefined and you cannot rely on them. Portable AnyEvent	356	presence is undefined and you cannot rely on them. Portable AnyEvent
240	callbacks cannot use arguments passed to signal watcher callbacks.	357	callbacks cannot use arguments passed to signal watcher callbacks.
241		358
…		…
257	=head2 CHILD PROCESS WATCHERS	374	=head2 CHILD PROCESS WATCHERS
258		375
259	You can also watch on a child process exit and catch its exit status.	376	You can also watch on a child process exit and catch its exit status.
260		377
261	The child process is specified by the C<pid> argument (if set to C<0>, it	378	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	379	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	380	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	381	any trace events (stopped/continued).
265	and exit status (as returned by waitpid), so unlike other watcher types,	382
266	you I<can> rely on child watcher callback arguments.	383	The callback will be called with the pid and exit status (as returned by
		384	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		385	callback arguments.
		386
		387	This watcher type works by installing a signal handler for C<SIGCHLD>,
		388	and since it cannot be shared, nothing else should use SIGCHLD or reap
		389	random child processes (waiting for specific child processes, e.g. inside
		390	C<system>, is just fine).
267		391
268	There is a slight catch to child watchers, however: you usually start them	392	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	393	I<after> the child process was created, and this means the process could
270	have exited already (and no SIGCHLD will be sent anymore).	394	have exited already (and no SIGCHLD will be sent anymore).
271		395
…		…
277	AnyEvent program, you I<have> to create at least one watcher before you	401	AnyEvent program, you I<have> to create at least one watcher before you
278	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	402	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
279		403
280	Example: fork a process and wait for it	404	Example: fork a process and wait for it
281		405
282	my $done = AnyEvent->condvar;	406	my $done = AnyEvent->condvar;
283		407
284	my $pid = fork or exit 5;	408	my $pid = fork or exit 5;
285		409
286	my $w = AnyEvent->child (	410	my $w = AnyEvent->child (
287	pid => $pid,	411	pid => $pid,
288	cb => sub {	412	cb => sub {
289	my ($pid, $status) = @_;	413	my ($pid, $status) = @_;
290	warn "pid $pid exited with status $status";	414	warn "pid $pid exited with status $status";
291	$done->send;	415	$done->send;
292	},	416	},
293	);	417	);
294		418
295	# do something else, then wait for process exit	419	# do something else, then wait for process exit
296	$done->recv;	420	$done->recv;
		421
		422	=head2 IDLE WATCHERS
		423
		424	Sometimes there is a need to do something, but it is not so important
		425	to do it instantly, but only when there is nothing better to do. This
		426	"nothing better to do" is usually defined to be "no other events need
		427	attention by the event loop".
		428
		429	Idle watchers ideally get invoked when the event loop has nothing
		430	better to do, just before it would block the process to wait for new
		431	events. Instead of blocking, the idle watcher is invoked.
		432
		433	Most event loops unfortunately do not really support idle watchers (only
		434	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		435	will simply call the callback "from time to time".
		436
		437	Example: read lines from STDIN, but only process them when the
		438	program is otherwise idle:
		439
		440	my @lines; # read data
		441	my $idle_w;
		442	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		443	push @lines, scalar <STDIN>;
		444
		445	# start an idle watcher, if not already done
		446	$idle_w \|\|= AnyEvent->idle (cb => sub {
		447	# handle only one line, when there are lines left
		448	if (my $line = shift @lines) {
		449	print "handled when idle: $line";
		450	} else {
		451	# otherwise disable the idle watcher again
		452	undef $idle_w;
		453	}
		454	});
		455	});
297		456
298	=head2 CONDITION VARIABLES	457	=head2 CONDITION VARIABLES
299		458
300	If you are familiar with some event loops you will know that all of them	459	If you are familiar with some event loops you will know that all of them
301	require you to run some blocking "loop", "run" or similar function that	460	require you to run some blocking "loop", "run" or similar function that
…		…
307	The instrument to do that is called a "condition variable", so called	466	The instrument to do that is called a "condition variable", so called
308	because they represent a condition that must become true.	467	because they represent a condition that must become true.
309		468
310	Condition variables can be created by calling the C<< AnyEvent->condvar	469	Condition variables can be created by calling the C<< AnyEvent->condvar
311	>> method, usually without arguments. The only argument pair allowed is	470	>> method, usually without arguments. The only argument pair allowed is
		471
312	C<cb>, which specifies a callback to be called when the condition variable	472	C<cb>, which specifies a callback to be called when the condition variable
313	becomes true.	473	becomes true, with the condition variable as the first argument (but not
		474	the results).
314		475
315	After creation, the condition variable is "false" until it becomes "true"	476	After creation, the condition variable is "false" until it becomes "true"
316	by calling the C<send> method (or calling the condition variable as if it	477	by calling the C<send> method (or calling the condition variable as if it
317	were a callback).	478	were a callback, read about the caveats in the description for the C<<
		479	->send >> method).
318		480
319	Condition variables are similar to callbacks, except that you can	481	Condition variables are similar to callbacks, except that you can
320	optionally wait for them. They can also be called merge points - points	482	optionally wait for them. They can also be called merge points - points
321	in time where multiple outstanding events have been processed. And yet	483	in time where multiple outstanding events have been processed. And yet
322	another way to call them is transactions - each condition variable can be	484	another way to call them is transactions - each condition variable can be
…		…
373		535
374	my $done = AnyEvent->condvar;	536	my $done = AnyEvent->condvar;
375	my $delay = AnyEvent->timer (after => 5, cb => $done);	537	my $delay = AnyEvent->timer (after => 5, cb => $done);
376	$done->recv;	538	$done->recv;
377		539
		540	Example: Imagine an API that returns a condvar and doesn't support
		541	callbacks. This is how you make a synchronous call, for example from
		542	the main program:
		543
		544	use AnyEvent::CouchDB;
		545
		546	...
		547
		548	my @info = $couchdb->info->recv;
		549
		550	And this is how you would just ste a callback to be called whenever the
		551	results are available:
		552
		553	$couchdb->info->cb (sub {
		554	my @info = $_[0]->recv;
		555	});
		556
378	=head3 METHODS FOR PRODUCERS	557	=head3 METHODS FOR PRODUCERS
379		558
380	These methods should only be used by the producing side, i.e. the	559	These methods should only be used by the producing side, i.e. the
381	code/module that eventually sends the signal. Note that it is also	560	code/module that eventually sends the signal. Note that it is also
382	the producer side which creates the condvar in most cases, but it isn't	561	the producer side which creates the condvar in most cases, but it isn't
…		…
394	immediately from within send.	573	immediately from within send.
395		574
396	Any arguments passed to the C<send> call will be returned by all	575	Any arguments passed to the C<send> call will be returned by all
397	future C<< ->recv >> calls.	576	future C<< ->recv >> calls.
398		577
399	Condition variables are overloaded so one can call them directly (as a	578	Condition variables are overloaded so one can call them directly
400	code reference). Calling them directly is the same as calling C<send>.	579	(as a code reference). Calling them directly is the same as calling
		580	C<send>. Note, however, that many C-based event loops do not handle
		581	overloading, so as tempting as it may be, passing a condition variable
		582	instead of a callback does not work. Both the pure perl and EV loops
		583	support overloading, however, as well as all functions that use perl to
		584	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
		585	example).
401		586
402	=item $cv->croak ($error)	587	=item $cv->croak ($error)
403		588
404	Similar to send, but causes all call's to C<< ->recv >> to invoke	589	Similar to send, but causes all call's to C<< ->recv >> to invoke
405	C<Carp::croak> with the given error message/object/scalar.	590	C<Carp::croak> with the given error message/object/scalar.
…		…
509	=item $bool = $cv->ready	694	=item $bool = $cv->ready
510		695
511	Returns true when the condition is "true", i.e. whether C<send> or	696	Returns true when the condition is "true", i.e. whether C<send> or
512	C<croak> have been called.	697	C<croak> have been called.
513		698
514	=item $cb = $cv->cb ([new callback])	699	=item $cb = $cv->cb ($cb->($cv))
515		700
516	This is a mutator function that returns the callback set and optionally	701	This is a mutator function that returns the callback set and optionally
517	replaces it before doing so.	702	replaces it before doing so.
518		703
519	The callback will be called when the condition becomes "true", i.e. when	704	The callback will be called when the condition becomes "true", i.e. when
520	C<send> or C<croak> are called. Calling C<recv> inside the callback	705	C<send> or C<croak> are called, with the only argument being the condition
521	or at any later time is guaranteed not to block.	706	variable itself. Calling C<recv> inside the callback or at any later time
		707	is guaranteed not to block.
522		708
523	=back	709	=back
524		710
525	=head1 GLOBAL VARIABLES AND FUNCTIONS	711	=head1 GLOBAL VARIABLES AND FUNCTIONS
526		712
…		…
655	=item L<AnyEvent::Util>	841	=item L<AnyEvent::Util>
656		842
657	Contains various utility functions that replace often-used but blocking	843	Contains various utility functions that replace often-used but blocking
658	functions such as C<inet_aton> by event-/callback-based versions.	844	functions such as C<inet_aton> by event-/callback-based versions.
659		845
660	=item L<AnyEvent::Handle>
661
662	Provide read and write buffers and manages watchers for reads and writes.
663
664	=item L<AnyEvent::Socket>	846	=item L<AnyEvent::Socket>
665		847
666	Provides various utility functions for (internet protocol) sockets,	848	Provides various utility functions for (internet protocol) sockets,
667	addresses and name resolution. Also functions to create non-blocking tcp	849	addresses and name resolution. Also functions to create non-blocking tcp
668	connections or tcp servers, with IPv6 and SRV record support and more.	850	connections or tcp servers, with IPv6 and SRV record support and more.
669		851
		852	=item L<AnyEvent::Handle>
		853
		854	Provide read and write buffers, manages watchers for reads and writes,
		855	supports raw and formatted I/O, I/O queued and fully transparent and
		856	non-blocking SSL/TLS.
		857
670	=item L<AnyEvent::DNS>	858	=item L<AnyEvent::DNS>
671		859
672	Provides rich asynchronous DNS resolver capabilities.	860	Provides rich asynchronous DNS resolver capabilities.
673		861
		862	=item L<AnyEvent::HTTP>
		863
		864	A simple-to-use HTTP library that is capable of making a lot of concurrent
		865	HTTP requests.
		866
674	=item L<AnyEvent::HTTPD>	867	=item L<AnyEvent::HTTPD>
675		868
676	Provides a simple web application server framework.	869	Provides a simple web application server framework.
677		870
678	=item L<AnyEvent::FastPing>	871	=item L<AnyEvent::FastPing>
679		872
680	The fastest ping in the west.	873	The fastest ping in the west.
681		874
		875	=item L<AnyEvent::DBI>
		876
		877	Executes L<DBI> requests asynchronously in a proxy process.
		878
		879	=item L<AnyEvent::AIO>
		880
		881	Truly asynchronous I/O, should be in the toolbox of every event
		882	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
		883	together.
		884
		885	=item L<AnyEvent::BDB>
		886
		887	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
		888	L<BDB> and AnyEvent together.
		889
		890	=item L<AnyEvent::GPSD>
		891
		892	A non-blocking interface to gpsd, a daemon delivering GPS information.
		893
		894	=item L<AnyEvent::IGS>
		895
		896	A non-blocking interface to the Internet Go Server protocol (used by
		897	L<App::IGS>).
		898
682	=item L<Net::IRC3>	899	=item L<AnyEvent::IRC>
683		900
684	AnyEvent based IRC client module family.	901	AnyEvent based IRC client module family (replacing the older Net::IRC3).
685		902
686	=item L<Net::XMPP2>	903	=item L<Net::XMPP2>
687		904
688	AnyEvent based XMPP (Jabber protocol) module family.	905	AnyEvent based XMPP (Jabber protocol) module family.
689		906
…		…
698		915
699	=item L<Coro>	916	=item L<Coro>
700		917
701	Has special support for AnyEvent via L<Coro::AnyEvent>.	918	Has special support for AnyEvent via L<Coro::AnyEvent>.
702		919
703	=item L<AnyEvent::AIO>, L<IO::AIO>
704
705	Truly asynchronous I/O, should be in the toolbox of every event
706	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
707	together.
708
709	=item L<AnyEvent::BDB>, L<BDB>
710
711	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
712	IO::AIO and AnyEvent together.
713
714	=item L<IO::Lambda>	920	=item L<IO::Lambda>
715		921
716	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.	922	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
717		923
718	=back	924	=back
…		…
720	=cut	926	=cut
721		927
722	package AnyEvent;	928	package AnyEvent;
723		929
724	no warnings;	930	no warnings;
725	use strict;	931	use strict qw(vars subs);
726		932
727	use Carp;	933	use Carp;
728		934
729	our $VERSION = '4.03';	935	our $VERSION = 4.4;
730	our $MODEL;	936	our $MODEL;
731		937
732	our $AUTOLOAD;	938	our $AUTOLOAD;
733	our @ISA;	939	our @ISA;
734		940
		941	our @REGISTRY;
		942
		943	our $WIN32;
		944
		945	BEGIN {
		946	my $win32 = ! ! ($^O =~ /mswin32/i);
		947	eval "sub WIN32(){ $win32 }";
		948	}
		949
735	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	950	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
736		951
737	our @REGISTRY;	952	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
738
739	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2)
740		953
741	{	954	{
742	my $idx;	955	my $idx;
743	$PROTOCOL{$_} = ++$idx	956	$PROTOCOL{$_} = ++$idx
		957	for reverse split /\s,\s/,
744	for split /\s,\s/, $ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	958	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
745	}	959	}
746		960
747	my @models = (	961	my @models = (
748	[EV:: => AnyEvent::Impl::EV::],	962	[EV:: => AnyEvent::Impl::EV::],
749	[Event:: => AnyEvent::Impl::Event::],	963	[Event:: => AnyEvent::Impl::Event::],
750	[Tk:: => AnyEvent::Impl::Tk::],
751	[Wx:: => AnyEvent::Impl::POE::],
752	[Prima:: => AnyEvent::Impl::POE::],
753	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	964	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
754	# everything below here will not be autoprobed as the pureperl backend should work everywhere	965	# everything below here will not be autoprobed
755	[Glib:: => AnyEvent::Impl::Glib::],	966	# as the pureperl backend should work everywhere
		967	# and is usually faster
		968	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		969	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
756	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	970	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
757	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	971	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
758	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	972	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
		973	[Wx:: => AnyEvent::Impl::POE::],
		974	[Prima:: => AnyEvent::Impl::POE::],
759	);	975	);
760		976
761	our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);	977	our %method = map +($_ => 1),
		978	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
762		979
763	our @post_detect;	980	our @post_detect;
764		981
765	sub post_detect(&) {	982	sub post_detect(&) {
766	my ($cb) = @_;	983	my ($cb) = @_;
…		…
771	1	988	1
772	} else {	989	} else {
773	push @post_detect, $cb;	990	push @post_detect, $cb;
774		991
775	defined wantarray	992	defined wantarray
776	? bless \$cb, "AnyEvent::Util::PostDetect"	993	? bless \$cb, "AnyEvent::Util::postdetect"
777	: ()	994	: ()
778	}	995	}
779	}	996	}
780		997
781	sub AnyEvent::Util::PostDetect::DESTROY {	998	sub AnyEvent::Util::postdetect::DESTROY {
782	@post_detect = grep $_ != ${$_[0]}, @post_detect;	999	@post_detect = grep $_ != ${$_[0]}, @post_detect;
783	}	1000	}
784		1001
785	sub detect() {	1002	sub detect() {
786	unless ($MODEL) {	1003	unless ($MODEL) {
787	no strict 'refs';	1004	no strict 'refs';
		1005	local $SIG{__DIE__};
788		1006
789	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1007	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
790	my $model = "AnyEvent::Impl::$1";	1008	my $model = "AnyEvent::Impl::$1";
791	if (eval "require $model") {	1009	if (eval "require $model") {
792	$MODEL = $model;	1010	$MODEL = $model;
…		…
822	last;	1040	last;
823	}	1041	}
824	}	1042	}
825		1043
826	$MODEL	1044	$MODEL
827	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1045	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
828	}	1046	}
829	}	1047	}
830		1048
		1049	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1050
831	unshift @ISA, $MODEL;	1051	unshift @ISA, $MODEL;
832	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1052
		1053	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
833		1054
834	(shift @post_detect)->() while @post_detect;	1055	(shift @post_detect)->() while @post_detect;
835	}	1056	}
836		1057
837	$MODEL	1058	$MODEL
…		…
847		1068
848	my $class = shift;	1069	my $class = shift;
849	$class->$func (@_);	1070	$class->$func (@_);
850	}	1071	}
851		1072
		1073	# utility function to dup a filehandle. this is used by many backends
		1074	# to support binding more than one watcher per filehandle (they usually
		1075	# allow only one watcher per fd, so we dup it to get a different one).
		1076	sub _dupfh($$$$) {
		1077	my ($poll, $fh, $r, $w) = @_;
		1078
		1079	# cygwin requires the fh mode to be matching, unix doesn't
		1080	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
		1081	: $poll eq "w" ? ($w, ">")
		1082	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
		1083
		1084	open my $fh2, "$mode&" . fileno $fh
		1085	or die "cannot dup() filehandle: $!,";
		1086
		1087	# we assume CLOEXEC is already set by perl in all important cases
		1088
		1089	($fh2, $rw)
		1090	}
		1091
852	package AnyEvent::Base;	1092	package AnyEvent::Base;
853		1093
		1094	# default implementations for many methods
		1095
		1096	BEGIN {
		1097	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1098	*_time = \&Time::HiRes::time;
		1099	# if (eval "use POSIX (); (POSIX::times())...
		1100	} else {
		1101	*_time = sub { time }; # epic fail
		1102	}
		1103	}
		1104
		1105	sub time { _time }
		1106	sub now { _time }
		1107	sub now_update { }
		1108
854	# default implementation for ->condvar	1109	# default implementation for ->condvar
855		1110
856	sub condvar {	1111	sub condvar {
857	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1112	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
858	}	1113	}
859		1114
860	# default implementation for ->signal	1115	# default implementation for ->signal
861		1116
862	our %SIG_CB;	1117	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1118
		1119	sub _signal_exec {
		1120	sysread $SIGPIPE_R, my $dummy, 4;
		1121
		1122	while (%SIG_EV) {
		1123	for (keys %SIG_EV) {
		1124	delete $SIG_EV{$_};
		1125	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1126	}
		1127	}
		1128	}
863		1129
864	sub signal {	1130	sub signal {
865	my (undef, %arg) = @_;	1131	my (undef, %arg) = @_;
866		1132
		1133	unless ($SIGPIPE_R) {
		1134	require Fcntl;
		1135
		1136	if (AnyEvent::WIN32) {
		1137	require AnyEvent::Util;
		1138
		1139	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1140	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1141	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1142	} else {
		1143	pipe $SIGPIPE_R, $SIGPIPE_W;
		1144	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1145	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1146	}
		1147
		1148	$SIGPIPE_R
		1149	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1150
		1151	# not strictly required, as $^F is normally 2, but let's make sure...
		1152	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1153	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1154
		1155	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1156	}
		1157
867	my $signal = uc $arg{signal}	1158	my $signal = uc $arg{signal}
868	or Carp::croak "required option 'signal' is missing";	1159	or Carp::croak "required option 'signal' is missing";
869		1160
870	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1161	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
871	$SIG{$signal} \|\|= sub {	1162	$SIG{$signal} \|\|= sub {
872	$_->() for values %{ $SIG_CB{$signal} \|\| {} };	1163	local $!;
		1164	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1165	undef $SIG_EV{$signal};
873	};	1166	};
874		1167
875	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1168	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
876	}	1169	}
877		1170
878	sub AnyEvent::Base::Signal::DESTROY {	1171	sub AnyEvent::Base::signal::DESTROY {
879	my ($signal, $cb) = @{$_[0]};	1172	my ($signal, $cb) = @{$_[0]};
880		1173
881	delete $SIG_CB{$signal}{$cb};	1174	delete $SIG_CB{$signal}{$cb};
882		1175
883	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };	1176	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
884	}	1177	}
885		1178
886	# default implementation for ->child	1179	# default implementation for ->child
887		1180
888	our %PID_CB;	1181	our %PID_CB;
…		…
915	or Carp::croak "required option 'pid' is missing";	1208	or Carp::croak "required option 'pid' is missing";
916		1209
917	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1210	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
918		1211
919	unless ($WNOHANG) {	1212	unless ($WNOHANG) {
920	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } \|\| 1;	1213	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
921	}	1214	}
922		1215
923	unless ($CHLD_W) {	1216	unless ($CHLD_W) {
924	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1217	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
925	# child could be a zombie already, so make at least one round	1218	# child could be a zombie already, so make at least one round
926	&_sigchld;	1219	&_sigchld;
927	}	1220	}
928		1221
929	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1222	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
930	}	1223	}
931		1224
932	sub AnyEvent::Base::Child::DESTROY {	1225	sub AnyEvent::Base::child::DESTROY {
933	my ($pid, $cb) = @{$_[0]};	1226	my ($pid, $cb) = @{$_[0]};
934		1227
935	delete $PID_CB{$pid}{$cb};	1228	delete $PID_CB{$pid}{$cb};
936	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1229	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
937		1230
938	undef $CHLD_W unless keys %PID_CB;	1231	undef $CHLD_W unless keys %PID_CB;
		1232	}
		1233
		1234	# idle emulation is done by simply using a timer, regardless
		1235	# of whether the proces sis idle or not, and not letting
		1236	# the callback use more than 50% of the time.
		1237	sub idle {
		1238	my (undef, %arg) = @_;
		1239
		1240	my ($cb, $w, $rcb) = $arg{cb};
		1241
		1242	$rcb = sub {
		1243	if ($cb) {
		1244	$w = _time;
		1245	&$cb;
		1246	$w = _time - $w;
		1247
		1248	# never use more then 50% of the time for the idle watcher,
		1249	# within some limits
		1250	$w = 0.0001 if $w < 0.0001;
		1251	$w = 5 if $w > 5;
		1252
		1253	$w = AnyEvent->timer (after => $w, cb => $rcb);
		1254	} else {
		1255	# clean up...
		1256	undef $w;
		1257	undef $rcb;
		1258	}
		1259	};
		1260
		1261	$w = AnyEvent->timer (after => 0.05, cb => $rcb);
		1262
		1263	bless \\$cb, "AnyEvent::Base::idle"
		1264	}
		1265
		1266	sub AnyEvent::Base::idle::DESTROY {
		1267	undef $${$_[0]};
939	}	1268	}
940		1269
941	package AnyEvent::CondVar;	1270	package AnyEvent::CondVar;
942		1271
943	our @ISA = AnyEvent::CondVar::Base::;	1272	our @ISA = AnyEvent::CondVar::Base::;
…		…
995	}	1324	}
996		1325
997	# undocumented/compatibility with pre-3.4	1326	# undocumented/compatibility with pre-3.4
998	*broadcast = \&send;	1327	*broadcast = \&send;
999	*wait = \&_wait;	1328	*wait = \&_wait;
		1329
		1330	=head1 ERROR AND EXCEPTION HANDLING
		1331
		1332	In general, AnyEvent does not do any error handling - it relies on the
		1333	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1334	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1335	checking of all AnyEvent methods, however, which is highly useful during
		1336	development.
		1337
		1338	As for exception handling (i.e. runtime errors and exceptions thrown while
		1339	executing a callback), this is not only highly event-loop specific, but
		1340	also not in any way wrapped by this module, as this is the job of the main
		1341	program.
		1342
		1343	The pure perl event loop simply re-throws the exception (usually
		1344	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1345	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1346	so on.
		1347
		1348	=head1 ENVIRONMENT VARIABLES
		1349
		1350	The following environment variables are used by this module or its
		1351	submodules:
		1352
		1353	=over 4
		1354
		1355	=item C<PERL_ANYEVENT_VERBOSE>
		1356
		1357	By default, AnyEvent will be completely silent except in fatal
		1358	conditions. You can set this environment variable to make AnyEvent more
		1359	talkative.
		1360
		1361	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1362	conditions, such as not being able to load the event model specified by
		1363	C<PERL_ANYEVENT_MODEL>.
		1364
		1365	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1366	model it chooses.
		1367
		1368	=item C<PERL_ANYEVENT_STRICT>
		1369
		1370	AnyEvent does not do much argument checking by default, as thorough
		1371	argument checking is very costly. Setting this variable to a true value
		1372	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1373	check the arguments passed to most method calls. If it finds any problems
		1374	it will croak.
		1375
		1376	In other words, enables "strict" mode.
		1377
		1378	Unlike C<use strict>, it is definitely recommended ot keep it off in
		1379	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
		1380	developing programs can be very useful, however.
		1381
		1382	=item C<PERL_ANYEVENT_MODEL>
		1383
		1384	This can be used to specify the event model to be used by AnyEvent, before
		1385	auto detection and -probing kicks in. It must be a string consisting
		1386	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1387	and the resulting module name is loaded and if the load was successful,
		1388	used as event model. If it fails to load AnyEvent will proceed with
		1389	auto detection and -probing.
		1390
		1391	This functionality might change in future versions.
		1392
		1393	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1394	could start your program like this:
		1395
		1396	PERL_ANYEVENT_MODEL=Perl perl ...
		1397
		1398	=item C<PERL_ANYEVENT_PROTOCOLS>
		1399
		1400	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1401	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1402	of auto probing).
		1403
		1404	Must be set to a comma-separated list of protocols or address families,
		1405	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1406	used, and preference will be given to protocols mentioned earlier in the
		1407	list.
		1408
		1409	This variable can effectively be used for denial-of-service attacks
		1410	against local programs (e.g. when setuid), although the impact is likely
		1411	small, as the program has to handle conenction and other failures anyways.
		1412
		1413	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1414	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1415	- only support IPv4, never try to resolve or contact IPv6
		1416	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1417	IPv6, but prefer IPv6 over IPv4.
		1418
		1419	=item C<PERL_ANYEVENT_EDNS0>
		1420
		1421	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1422	for DNS. This extension is generally useful to reduce DNS traffic, but
		1423	some (broken) firewalls drop such DNS packets, which is why it is off by
		1424	default.
		1425
		1426	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1427	EDNS0 in its DNS requests.
		1428
		1429	=item C<PERL_ANYEVENT_MAX_FORKS>
		1430
		1431	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1432	will create in parallel.
		1433
		1434	=back
1000		1435
1001	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1436	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1002		1437
1003	This is an advanced topic that you do not normally need to use AnyEvent in	1438	This is an advanced topic that you do not normally need to use AnyEvent in
1004	a module. This section is only of use to event loop authors who want to	1439	a module. This section is only of use to event loop authors who want to
…		…
1038		1473
1039	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1474	I<rxvt-unicode> also cheats a bit by not providing blocking access to
1040	condition variables: code blocking while waiting for a condition will	1475	condition variables: code blocking while waiting for a condition will
1041	C<die>. This still works with most modules/usages, and blocking calls must	1476	C<die>. This still works with most modules/usages, and blocking calls must
1042	not be done in an interactive application, so it makes sense.	1477	not be done in an interactive application, so it makes sense.
1043
1044	=head1 ENVIRONMENT VARIABLES
1045
1046	The following environment variables are used by this module:
1047
1048	=over 4
1049
1050	=item C<PERL_ANYEVENT_VERBOSE>
1051
1052	By default, AnyEvent will be completely silent except in fatal
1053	conditions. You can set this environment variable to make AnyEvent more
1054	talkative.
1055
1056	When set to C<1> or higher, causes AnyEvent to warn about unexpected
1057	conditions, such as not being able to load the event model specified by
1058	C<PERL_ANYEVENT_MODEL>.
1059
1060	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1061	model it chooses.
1062
1063	=item C<PERL_ANYEVENT_MODEL>
1064
1065	This can be used to specify the event model to be used by AnyEvent, before
1066	auto detection and -probing kicks in. It must be a string consisting
1067	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1068	and the resulting module name is loaded and if the load was successful,
1069	used as event model. If it fails to load AnyEvent will proceed with
1070	auto detection and -probing.
1071
1072	This functionality might change in future versions.
1073
1074	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1075	could start your program like this:
1076
1077	PERL_ANYEVENT_MODEL=Perl perl ...
1078
1079	=item C<PERL_ANYEVENT_PROTOCOLS>
1080
1081	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1082	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1083	of auto probing).
1084
1085	Must be set to a comma-separated list of protocols or address families,
1086	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1087	used, and preference will be given to protocols mentioned earlier in the
1088	list.
1089
1090	This variable can effectively be used for denial-of-service attacks
1091	against local programs (e.g. when setuid), although the impact is likely
1092	small, as the program has to handle connection errors already-
1093
1094	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1095	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1096	- only support IPv4, never try to resolve or contact IPv6
1097	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1098	IPv6, but prefer IPv6 over IPv4.
1099
1100	=item C<PERL_ANYEVENT_EDNS0>
1101
1102	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1103	for DNS. This extension is generally useful to reduce DNS traffic, but
1104	some (broken) firewalls drop such DNS packets, which is why it is off by
1105	default.
1106
1107	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1108	EDNS0 in its DNS requests.
1109
1110	=back
1111		1478
1112	=head1 EXAMPLE PROGRAM	1479	=head1 EXAMPLE PROGRAM
1113		1480
1114	The following program uses an I/O watcher to read data from STDIN, a timer	1481	The following program uses an I/O watcher to read data from STDIN, a timer
1115	to display a message once per second, and a condition variable to quit the	1482	to display a message once per second, and a condition variable to quit the
…		…
1309	watcher.	1676	watcher.
1310		1677
1311	=head3 Results	1678	=head3 Results
1312		1679
1313	name watchers bytes create invoke destroy comment	1680	name watchers bytes create invoke destroy comment
1314	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1681	EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1315	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	1682	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1316	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	1683	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1317	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	1684	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1318	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	1685	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1319	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	1686	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1320	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	1687	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1321	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	1688	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1322	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	1689	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1323	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	1690	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1324		1691
1325	=head3 Discussion	1692	=head3 Discussion
1326		1693
1327	The benchmark does I<not> measure scalability of the event loop very	1694	The benchmark does I<not> measure scalability of the event loop very
1328	well. For example, a select-based event loop (such as the pure perl one)	1695	well. For example, a select-based event loop (such as the pure perl one)
…		…
1530	watchers, as the management overhead dominates.	1897	watchers, as the management overhead dominates.
1531		1898
1532	=back	1899	=back
1533		1900
1534		1901
		1902	=head1 SIGNALS
		1903
		1904	AnyEvent currently installs handlers for these signals:
		1905
		1906	=over 4
		1907
		1908	=item SIGCHLD
		1909
		1910	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		1911	emulation for event loops that do not support them natively. Also, some
		1912	event loops install a similar handler.
		1913
		1914	=item SIGPIPE
		1915
		1916	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		1917	when AnyEvent gets loaded.
		1918
		1919	The rationale for this is that AnyEvent users usually do not really depend
		1920	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		1921	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		1922	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		1923	some random socket.
		1924
		1925	The rationale for installing a no-op handler as opposed to ignoring it is
		1926	that this way, the handler will be restored to defaults on exec.
		1927
		1928	Feel free to install your own handler, or reset it to defaults.
		1929
		1930	=back
		1931
		1932	=cut
		1933
		1934	$SIG{PIPE} = sub { }
		1935	unless defined $SIG{PIPE};
		1936
		1937
1535	=head1 FORK	1938	=head1 FORK
1536		1939
1537	Most event libraries are not fork-safe. The ones who are usually are	1940	Most event libraries are not fork-safe. The ones who are usually are
1538	because they rely on inefficient but fork-safe C<select> or C<poll>	1941	because they rely on inefficient but fork-safe C<select> or C<poll>
1539	calls. Only L<EV> is fully fork-aware.	1942	calls. Only L<EV> is fully fork-aware.
…		…
1552	specified in the variable.	1955	specified in the variable.
1553		1956
1554	You can make AnyEvent completely ignore this variable by deleting it	1957	You can make AnyEvent completely ignore this variable by deleting it
1555	before the first watcher gets created, e.g. with a C<BEGIN> block:	1958	before the first watcher gets created, e.g. with a C<BEGIN> block:
1556		1959
1557	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	1960	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1558		1961
1559	use AnyEvent;	1962	use AnyEvent;
1560		1963
1561	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	1964	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1562	be used to probe what backend is used and gain other information (which is	1965	be used to probe what backend is used and gain other information (which is
1563	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	1966	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		1967	$ENV{PERL_ANYEGENT_STRICT}.
		1968
		1969
		1970	=head1 BUGS
		1971
		1972	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		1973	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		1974	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		1975	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
		1976	pronounced).
1564		1977
1565		1978
1566	=head1 SEE ALSO	1979	=head1 SEE ALSO
1567		1980
1568	Utility functions: L<AnyEvent::Util>.	1981	Utility functions: L<AnyEvent::Util>.
…		…
1585	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	1998	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1586		1999
1587		2000
1588	=head1 AUTHOR	2001	=head1 AUTHOR
1589		2002
1590	Marc Lehmann <schmorp@schmorp.de>	2003	Marc Lehmann <schmorp@schmorp.de>
1591	http://home.schmorp.de/	2004	http://home.schmorp.de/
1592		2005
1593	=cut	2006	=cut
1594		2007
1595	1	2008	1
1596		2009

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.134 by root, Sun May 25 04:44:04 2008 UTC vs. Revision 1.208 by root, Sun Apr 26 18:12:53 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.134 by root, Sun May 25 04:44:04 2008 UTC vs.
Revision 1.208 by root, Sun Apr 26 18:12:53 2009 UTC