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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.164 by root, Tue Jul 8 19:50:25 2008 UTC vs.
Revision 1.231 by root, Wed Jul 8 13:46:46 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
20	$w->send; # wake up current and all future recv's	35	$w->send; # wake up current and all future recv's
21	$w->recv; # enters "main loop" till $condvar gets ->send	36	$w->recv; # enters "main loop" till $condvar gets ->send
		37	# use a condvar in callback mode:
		38	$w->cb (sub { $_[0]->recv });
22		39
23	=head1 INTRODUCTION/TUTORIAL	40	=head1 INTRODUCTION/TUTORIAL
24		41
25	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
26	in a tutorial or some gentle introduction, have a look at the	43	in a tutorial or some gentle introduction, have a look at the
33		50
34	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	51	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35	policy> and AnyEvent is I<small and efficient>.	52	policy> and AnyEvent is I<small and efficient>.
36		53
37	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
38	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
39	pragmatic way. For event models and certain classes of immortals alike,	56	pragmatic way. For event models and certain classes of immortals alike,
40	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,
41	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
42	helps hiding the differences between those event loops.	59	cannot change this, but it can hide the differences between those event
		60	loops.
43		61
44	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
45	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
46	religion, a way of living, and most importantly: without forcing your	64	religion, a way of living, and most importantly: without forcing your
47	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
48	model you use.	66	model you use.
49		67
50	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
51	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
52	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
53	cannot use anything else, as it is simply incompatible to everything that	71	cannot use anything else, as they are simply incompatible to everything
54	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
55	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.
56		74
57	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	75	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58	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
59	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
60	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,
61	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
62	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
63	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
64	event loops to AnyEvent, too, so it is future-proof).	82	to AnyEvent, too, so it is future-proof).
65		83
66	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
67	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
68	modules, you get an enormous amount of code and strict rules you have to	86	modules, you get an enormous amount of code and strict rules you have to
69	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
…		…
127	These watchers are normal Perl objects with normal Perl lifetime. After	145	These watchers are normal Perl objects with normal Perl lifetime. After
128	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
129	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
130	is in control).	148	is in control).
131		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
132	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
133	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
134	to it).	158	to it).
135		159
136	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.
…		…
152	=head2 I/O WATCHERS	176	=head2 I/O WATCHERS
153		177
154	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
155	with the following mandatory key-value pairs as arguments:	179	with the following mandatory key-value pairs as arguments:
156		180
157	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	181	C<fh> is the Perl I<file handle> (or a naked 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
158	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
159	which creates a watcher waiting for "r"eadable or "w"ritable events,	189	watcher waiting for "r"eadable or "w"ritable events, respectively.
		190
160	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.
161	becomes ready.
162		192
163	Although the callback might get passed parameters, their value and	193	Although the callback might get passed parameters, their value and
164	presence is undefined and you cannot rely on them. Portable AnyEvent	194	presence is undefined and you cannot rely on them. Portable AnyEvent
165	callbacks cannot use arguments passed to I/O watcher callbacks.	195	callbacks cannot use arguments passed to I/O watcher callbacks.
166		196
…		…
193	Although the callback might get passed parameters, their value and	223	Although the callback might get passed parameters, their value and
194	presence is undefined and you cannot rely on them. Portable AnyEvent	224	presence is undefined and you cannot rely on them. Portable AnyEvent
195	callbacks cannot use arguments passed to time watcher callbacks.	225	callbacks cannot use arguments passed to time watcher callbacks.
196		226
197	The callback will normally be invoked once only. If you specify another	227	The callback will normally be invoked once only. If you specify another
198	parameter, C<interval>, as a positive number, then the callback will be	228	parameter, C<interval>, as a strictly positive number (> 0), then the
199	invoked regularly at that interval (in fractional seconds) after the first	229	callback will be invoked regularly at that interval (in fractional
200	invocation.	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.
201		232
202	The callback will be rescheduled before invoking the callback, but no	233	The callback will be rescheduled before invoking the callback, but no
203	attempt is done to avoid timer drift in most backends, so the interval is	234	attempt is done to avoid timer drift in most backends, so the interval is
204	only approximate.	235	only approximate.
205		236
…		…
297	In either case, if you care (and in most cases, you don't), then you	328	In either case, if you care (and in most cases, you don't), then you
298	can get whatever behaviour you want with any event loop, by taking the	329	can get whatever behaviour you want with any event loop, by taking the
299	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	330	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
300	account.	331	account.
301		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
302	=back	348	=back
303		349
304	=head2 SIGNAL WATCHERS	350	=head2 SIGNAL WATCHERS
305		351
306	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
307	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
308	be invoked whenever a signal occurs.	354	callback to be invoked whenever a signal occurs.
309		355
310	Although the callback might get passed parameters, their value and	356	Although the callback might get passed parameters, their value and
311	presence is undefined and you cannot rely on them. Portable AnyEvent	357	presence is undefined and you cannot rely on them. Portable AnyEvent
312	callbacks cannot use arguments passed to signal watcher callbacks.	358	callbacks cannot use arguments passed to signal watcher callbacks.
313		359
…		…
329	=head2 CHILD PROCESS WATCHERS	375	=head2 CHILD PROCESS WATCHERS
330		376
331	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.
332		378
333	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
334	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
335	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
336	signal handler for C<SIGCHLD>. The callback will be called with the pid	382	any trace events (stopped/continued).
337	and exit status (as returned by waitpid), so unlike other watcher types,	383
338	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).
339		392
340	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
341	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
342	have exited already (and no SIGCHLD will be sent anymore).	395	have exited already (and no SIGCHLD will be sent anymore).
343		396
344	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
345	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
346	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.
347		403
348	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
349	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
350	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>).
351		408
352	Example: fork a process and wait for it	409	Example: fork a process and wait for it
353		410
354	my $done = AnyEvent->condvar;	411	my $done = AnyEvent->condvar;
355		412
…		…
365	);	422	);
366		423
367	# do something else, then wait for process exit	424	# do something else, then wait for process exit
368	$done->recv;	425	$done->recv;
369		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	});
		461
370	=head2 CONDITION VARIABLES	462	=head2 CONDITION VARIABLES
371		463
372	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
373	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
374	will actively watch for new events and call your callbacks.	466	will actively watch for new events and call your callbacks.
…		…
379	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
380	because they represent a condition that must become true.	472	because they represent a condition that must become true.
381		473
382	Condition variables can be created by calling the C<< AnyEvent->condvar	474	Condition variables can be created by calling the C<< AnyEvent->condvar
383	>> method, usually without arguments. The only argument pair allowed is	475	>> method, usually without arguments. The only argument pair allowed is
		476
384	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
385	becomes true.	478	becomes true, with the condition variable as the first argument (but not
		479	the results).
386		480
387	After creation, the condition variable is "false" until it becomes "true"	481	After creation, the condition variable is "false" until it becomes "true"
388	by calling the C<send> method (or calling the condition variable as if it	482	by calling the C<send> method (or calling the condition variable as if it
389	were a callback, read about the caveats in the description for the C<<	483	were a callback, read about the caveats in the description for the C<<
390	->send >> method).	484	->send >> method).
…		…
446		540
447	my $done = AnyEvent->condvar;	541	my $done = AnyEvent->condvar;
448	my $delay = AnyEvent->timer (after => 5, cb => $done);	542	my $delay = AnyEvent->timer (after => 5, cb => $done);
449	$done->recv;	543	$done->recv;
450		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	});
		561
451	=head3 METHODS FOR PRODUCERS	562	=head3 METHODS FOR PRODUCERS
452		563
453	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
454	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
455	the producer side which creates the condvar in most cases, but it isn't	566	the producer side which creates the condvar in most cases, but it isn't
…		…
488		599
489	=item $cv->begin ([group callback])	600	=item $cv->begin ([group callback])
490		601
491	=item $cv->end	602	=item $cv->end
492		603
493	These two methods are EXPERIMENTAL and MIGHT CHANGE.
494
495	These two methods can be used to combine many transactions/events into	604	These two methods can be used to combine many transactions/events into
496	one. For example, a function that pings many hosts in parallel might want	605	one. For example, a function that pings many hosts in parallel might want
497	to use a condition variable for the whole process.	606	to use a condition variable for the whole process.
498		607
499	Every call to C<< ->begin >> will increment a counter, and every call to	608	Every call to C<< ->begin >> will increment a counter, and every call to
500	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	609	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
501	>>, the (last) callback passed to C<begin> will be executed. That callback	610	>>, the (last) callback passed to C<begin> will be executed. That callback
502	is I<supposed> to call C<< ->send >>, but that is not required. If no	611	is I<supposed> to call C<< ->send >>, but that is not required. If no
503	callback was set, C<send> will be called without any arguments.	612	callback was set, C<send> will be called without any arguments.
504		613
505	Let's clarify this with the ping example:	614	You can think of C<< $cv->send >> giving you an OR condition (one call
		615	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		616	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		617
		618	Let's start with a simple example: you have two I/O watchers (for example,
		619	STDOUT and STDERR for a program), and you want to wait for both streams to
		620	close before activating a condvar:
		621
		622	my $cv = AnyEvent->condvar;
		623
		624	$cv->begin; # first watcher
		625	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		626	defined sysread $fh1, my $buf, 4096
		627	or $cv->end;
		628	});
		629
		630	$cv->begin; # second watcher
		631	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		632	defined sysread $fh2, my $buf, 4096
		633	or $cv->end;
		634	});
		635
		636	$cv->recv;
		637
		638	This works because for every event source (EOF on file handle), there is
		639	one call to C<begin>, so the condvar waits for all calls to C<end> before
		640	sending.
		641
		642	The ping example mentioned above is slightly more complicated, as the
		643	there are results to be passwd back, and the number of tasks that are
		644	begung can potentially be zero:
506		645
507	my $cv = AnyEvent->condvar;	646	my $cv = AnyEvent->condvar;
508		647
509	my %result;	648	my %result;
510	$cv->begin (sub { $cv->send (\%result) });	649	$cv->begin (sub { $cv->send (\%result) });
…		…
530	loop, which serves two important purposes: first, it sets the callback	669	loop, which serves two important purposes: first, it sets the callback
531	to be called once the counter reaches C<0>, and second, it ensures that	670	to be called once the counter reaches C<0>, and second, it ensures that
532	C<send> is called even when C<no> hosts are being pinged (the loop	671	C<send> is called even when C<no> hosts are being pinged (the loop
533	doesn't execute once).	672	doesn't execute once).
534		673
535	This is the general pattern when you "fan out" into multiple subrequests:	674	This is the general pattern when you "fan out" into multiple (but
536	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	675	potentially none) subrequests: use an outer C<begin>/C<end> pair to set
537	is called at least once, and then, for each subrequest you start, call	676	the callback and ensure C<end> is called at least once, and then, for each
538	C<begin> and for each subrequest you finish, call C<end>.	677	subrequest you start, call C<begin> and for each subrequest you finish,
		678	call C<end>.
539		679
540	=back	680	=back
541		681
542	=head3 METHODS FOR CONSUMERS	682	=head3 METHODS FOR CONSUMERS
543		683
…		…
588	=item $bool = $cv->ready	728	=item $bool = $cv->ready
589		729
590	Returns true when the condition is "true", i.e. whether C<send> or	730	Returns true when the condition is "true", i.e. whether C<send> or
591	C<croak> have been called.	731	C<croak> have been called.
592		732
593	=item $cb = $cv->cb ([new callback])	733	=item $cb = $cv->cb ($cb->($cv))
594		734
595	This is a mutator function that returns the callback set and optionally	735	This is a mutator function that returns the callback set and optionally
596	replaces it before doing so.	736	replaces it before doing so.
597		737
598	The callback will be called when the condition becomes "true", i.e. when	738	The callback will be called when the condition becomes "true", i.e. when
…		…
623	AnyEvent::Impl::Tk based on Tk, very bad choice.	763	AnyEvent::Impl::Tk based on Tk, very bad choice.
624	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).	764	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
625	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	765	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
626	AnyEvent::Impl::POE based on POE, not generic enough for full support.	766	AnyEvent::Impl::POE based on POE, not generic enough for full support.
627		767
		768	# warning, support for IO::Async is only partial, as it is too broken
		769	# and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
		770	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
		771
628	There is no support for WxWidgets, as WxWidgets has no support for	772	There is no support for WxWidgets, as WxWidgets has no support for
629	watching file handles. However, you can use WxWidgets through the	773	watching file handles. However, you can use WxWidgets through the
630	POE Adaptor, as POE has a Wx backend that simply polls 20 times per	774	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
631	second, which was considered to be too horrible to even consider for	775	second, which was considered to be too horrible to even consider for
632	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using	776	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
…		…
724		868
725		869
726	=head1 OTHER MODULES	870	=head1 OTHER MODULES
727		871
728	The following is a non-exhaustive list of additional modules that use	872	The following is a non-exhaustive list of additional modules that use
729	AnyEvent and can therefore be mixed easily with other AnyEvent modules	873	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
730	in the same program. Some of the modules come with AnyEvent, some are	874	modules and other event loops in the same program. Some of the modules
731	available via CPAN.	875	come with AnyEvent, most are available via CPAN.
732		876
733	=over 4	877	=over 4
734		878
735	=item L<AnyEvent::Util>	879	=item L<AnyEvent::Util>
736		880
…		…
745		889
746	=item L<AnyEvent::Handle>	890	=item L<AnyEvent::Handle>
747		891
748	Provide read and write buffers, manages watchers for reads and writes,	892	Provide read and write buffers, manages watchers for reads and writes,
749	supports raw and formatted I/O, I/O queued and fully transparent and	893	supports raw and formatted I/O, I/O queued and fully transparent and
750	non-blocking SSL/TLS.	894	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
751		895
752	=item L<AnyEvent::DNS>	896	=item L<AnyEvent::DNS>
753		897
754	Provides rich asynchronous DNS resolver capabilities.	898	Provides rich asynchronous DNS resolver capabilities.
755		899
…		…
783		927
784	=item L<AnyEvent::GPSD>	928	=item L<AnyEvent::GPSD>
785		929
786	A non-blocking interface to gpsd, a daemon delivering GPS information.	930	A non-blocking interface to gpsd, a daemon delivering GPS information.
787		931
		932	=item L<AnyEvent::IRC>
		933
		934	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		935
		936	=item L<AnyEvent::XMPP>
		937
		938	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		939	Net::XMPP2>.
		940
788	=item L<AnyEvent::IGS>	941	=item L<AnyEvent::IGS>
789		942
790	A non-blocking interface to the Internet Go Server protocol (used by	943	A non-blocking interface to the Internet Go Server protocol (used by
791	L<App::IGS>).	944	L<App::IGS>).
792		945
793	=item L<Net::IRC3>
794
795	AnyEvent based IRC client module family.
796
797	=item L<Net::XMPP2>
798
799	AnyEvent based XMPP (Jabber protocol) module family.
800
801	=item L<Net::FCP>	946	=item L<Net::FCP>
802		947
803	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	948	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
804	of AnyEvent.	949	of AnyEvent.
805		950
…		…
809		954
810	=item L<Coro>	955	=item L<Coro>
811		956
812	Has special support for AnyEvent via L<Coro::AnyEvent>.	957	Has special support for AnyEvent via L<Coro::AnyEvent>.
813		958
814	=item L<IO::Lambda>
815
816	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
817
818	=back	959	=back
819		960
820	=cut	961	=cut
821		962
822	package AnyEvent;	963	package AnyEvent;
823		964
824	no warnings;	965	no warnings;
825	use strict;	966	use strict qw(vars subs);
826		967
827	use Carp;	968	use Carp;
828		969
829	our $VERSION = 4.2;	970	our $VERSION = 4.801;
830	our $MODEL;	971	our $MODEL;
831		972
832	our $AUTOLOAD;	973	our $AUTOLOAD;
833	our @ISA;	974	our @ISA;
834		975
835	our @REGISTRY;	976	our @REGISTRY;
836		977
837	our $WIN32;	978	our $WIN32;
838		979
839	BEGIN {	980	BEGIN {
840	my $win32 = ! ! ($^O =~ /mswin32/i);	981	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
841	eval "sub WIN32(){ $win32 }";	982	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
		983
		984	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		985	if ${^TAINT};
842	}	986	}
843		987
844	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	988	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
845		989
846	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	990	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
864	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1008	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
865	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1009	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
866	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1010	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
867	[Wx:: => AnyEvent::Impl::POE::],	1011	[Wx:: => AnyEvent::Impl::POE::],
868	[Prima:: => AnyEvent::Impl::POE::],	1012	[Prima:: => AnyEvent::Impl::POE::],
		1013	# IO::Async is just too broken - we would need workaorunds for its
		1014	# byzantine signal and broken child handling, among others.
		1015	# IO::Async is rather hard to detect, as it doesn't have any
		1016	# obvious default class.
		1017	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1018	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1019	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
869	);	1020	);
870		1021
871	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1022	our %method = map +($_ => 1),
		1023	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
872		1024
873	our @post_detect;	1025	our @post_detect;
874		1026
875	sub post_detect(&) {	1027	sub post_detect(&) {
876	my ($cb) = @_;	1028	my ($cb) = @_;
…		…
881	1	1033	1
882	} else {	1034	} else {
883	push @post_detect, $cb;	1035	push @post_detect, $cb;
884		1036
885	defined wantarray	1037	defined wantarray
886	? bless \$cb, "AnyEvent::Util::PostDetect"	1038	? bless \$cb, "AnyEvent::Util::postdetect"
887	: ()	1039	: ()
888	}	1040	}
889	}	1041	}
890		1042
891	sub AnyEvent::Util::PostDetect::DESTROY {	1043	sub AnyEvent::Util::postdetect::DESTROY {
892	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1044	@post_detect = grep $_ != ${$_[0]}, @post_detect;
893	}	1045	}
894		1046
895	sub detect() {	1047	sub detect() {
896	unless ($MODEL) {	1048	unless ($MODEL) {
…		…
933	last;	1085	last;
934	}	1086	}
935	}	1087	}
936		1088
937	$MODEL	1089	$MODEL
938	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1090	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
939	}	1091	}
940	}	1092	}
941		1093
		1094	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1095
942	unshift @ISA, $MODEL;	1096	unshift @ISA, $MODEL;
943	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1097
		1098	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
944		1099
945	(shift @post_detect)->() while @post_detect;	1100	(shift @post_detect)->() while @post_detect;
946	}	1101	}
947		1102
948	$MODEL	1103	$MODEL
…		…
958		1113
959	my $class = shift;	1114	my $class = shift;
960	$class->$func (@_);	1115	$class->$func (@_);
961	}	1116	}
962		1117
		1118	# utility function to dup a filehandle. this is used by many backends
		1119	# to support binding more than one watcher per filehandle (they usually
		1120	# allow only one watcher per fd, so we dup it to get a different one).
		1121	sub _dupfh($$;$$) {
		1122	my ($poll, $fh, $r, $w) = @_;
		1123
		1124	# cygwin requires the fh mode to be matching, unix doesn't
		1125	my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">");
		1126
		1127	open my $fh2, "$mode&", $fh
		1128	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
		1129
		1130	# we assume CLOEXEC is already set by perl in all important cases
		1131
		1132	($fh2, $rw)
		1133	}
		1134
963	package AnyEvent::Base;	1135	package AnyEvent::Base;
964		1136
965	# default implementation for now and time	1137	# default implementations for many methods
966		1138
967	use Time::HiRes ();	1139	BEGIN {
		1140	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1141	*_time = \&Time::HiRes::time;
		1142	# if (eval "use POSIX (); (POSIX::times())...
		1143	} else {
		1144	*_time = sub { time }; # epic fail
		1145	}
		1146	}
968		1147
969	sub time { Time::HiRes::time }	1148	sub time { _time }
970	sub now { Time::HiRes::time }	1149	sub now { _time }
		1150	sub now_update { }
971		1151
972	# default implementation for ->condvar	1152	# default implementation for ->condvar
973		1153
974	sub condvar {	1154	sub condvar {
975	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1155	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
976	}	1156	}
977		1157
978	# default implementation for ->signal	1158	# default implementation for ->signal
979		1159
980	our %SIG_CB;	1160	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1161
		1162	sub _signal_exec {
		1163	sysread $SIGPIPE_R, my $dummy, 4;
		1164
		1165	while (%SIG_EV) {
		1166	for (keys %SIG_EV) {
		1167	delete $SIG_EV{$_};
		1168	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1169	}
		1170	}
		1171	}
981		1172
982	sub signal {	1173	sub signal {
983	my (undef, %arg) = @_;	1174	my (undef, %arg) = @_;
984		1175
		1176	unless ($SIGPIPE_R) {
		1177	require Fcntl;
		1178
		1179	if (AnyEvent::WIN32) {
		1180	require AnyEvent::Util;
		1181
		1182	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1183	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1184	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1185	} else {
		1186	pipe $SIGPIPE_R, $SIGPIPE_W;
		1187	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1188	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1189
		1190	# not strictly required, as $^F is normally 2, but let's make sure...
		1191	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1192	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1193	}
		1194
		1195	$SIGPIPE_R
		1196	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1197
		1198	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1199	}
		1200
985	my $signal = uc $arg{signal}	1201	my $signal = uc $arg{signal}
986	or Carp::croak "required option 'signal' is missing";	1202	or Carp::croak "required option 'signal' is missing";
987		1203
988	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1204	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
989	$SIG{$signal} \|\|= sub {	1205	$SIG{$signal} \|\|= sub {
990	$_->() for values %{ $SIG_CB{$signal} \|\| {} };	1206	local $!;
		1207	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1208	undef $SIG_EV{$signal};
991	};	1209	};
992		1210
993	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1211	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
994	}	1212	}
995		1213
996	sub AnyEvent::Base::Signal::DESTROY {	1214	sub AnyEvent::Base::signal::DESTROY {
997	my ($signal, $cb) = @{$_[0]};	1215	my ($signal, $cb) = @{$_[0]};
998		1216
999	delete $SIG_CB{$signal}{$cb};	1217	delete $SIG_CB{$signal}{$cb};
1000		1218
		1219	# delete doesn't work with older perls - they then
		1220	# print weird messages, or just unconditionally exit
		1221	# instead of getting the default action.
1001	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };	1222	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1002	}	1223	}
1003		1224
1004	# default implementation for ->child	1225	# default implementation for ->child
1005		1226
1006	our %PID_CB;	1227	our %PID_CB;
1007	our $CHLD_W;	1228	our $CHLD_W;
1008	our $CHLD_DELAY_W;	1229	our $CHLD_DELAY_W;
1009	our $PID_IDLE;
1010	our $WNOHANG;	1230	our $WNOHANG;
1011		1231
1012	sub _child_wait {	1232	sub _sigchld {
1013	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1233	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1014	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),	1234	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
1015	(values %{ $PID_CB{0} \|\| {} });	1235	(values %{ $PID_CB{0} \|\| {} });
1016	}	1236	}
1017
1018	undef $PID_IDLE;
1019	}
1020
1021	sub _sigchld {
1022	# make sure we deliver these changes "synchronous" with the event loop.
1023	$CHLD_DELAY_W \|\|= AnyEvent->timer (after => 0, cb => sub {
1024	undef $CHLD_DELAY_W;
1025	&_child_wait;
1026	});
1027	}	1237	}
1028		1238
1029	sub child {	1239	sub child {
1030	my (undef, %arg) = @_;	1240	my (undef, %arg) = @_;
1031		1241
1032	defined (my $pid = $arg{pid} + 0)	1242	defined (my $pid = $arg{pid} + 0)
1033	or Carp::croak "required option 'pid' is missing";	1243	or Carp::croak "required option 'pid' is missing";
1034		1244
1035	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1245	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1036		1246
1037	unless ($WNOHANG) {
1038	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1247	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1039	}
1040		1248
1041	unless ($CHLD_W) {	1249	unless ($CHLD_W) {
1042	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1250	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1043	# child could be a zombie already, so make at least one round	1251	# child could be a zombie already, so make at least one round
1044	&_sigchld;	1252	&_sigchld;
1045	}	1253	}
1046		1254
1047	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1255	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1048	}	1256	}
1049		1257
1050	sub AnyEvent::Base::Child::DESTROY {	1258	sub AnyEvent::Base::child::DESTROY {
1051	my ($pid, $cb) = @{$_[0]};	1259	my ($pid, $cb) = @{$_[0]};
1052		1260
1053	delete $PID_CB{$pid}{$cb};	1261	delete $PID_CB{$pid}{$cb};
1054	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1262	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1055		1263
1056	undef $CHLD_W unless keys %PID_CB;	1264	undef $CHLD_W unless keys %PID_CB;
		1265	}
		1266
		1267	# idle emulation is done by simply using a timer, regardless
		1268	# of whether the process is idle or not, and not letting
		1269	# the callback use more than 50% of the time.
		1270	sub idle {
		1271	my (undef, %arg) = @_;
		1272
		1273	my ($cb, $w, $rcb) = $arg{cb};
		1274
		1275	$rcb = sub {
		1276	if ($cb) {
		1277	$w = _time;
		1278	&$cb;
		1279	$w = _time - $w;
		1280
		1281	# never use more then 50% of the time for the idle watcher,
		1282	# within some limits
		1283	$w = 0.0001 if $w < 0.0001;
		1284	$w = 5 if $w > 5;
		1285
		1286	$w = AnyEvent->timer (after => $w, cb => $rcb);
		1287	} else {
		1288	# clean up...
		1289	undef $w;
		1290	undef $rcb;
		1291	}
		1292	};
		1293
		1294	$w = AnyEvent->timer (after => 0.05, cb => $rcb);
		1295
		1296	bless \\$cb, "AnyEvent::Base::idle"
		1297	}
		1298
		1299	sub AnyEvent::Base::idle::DESTROY {
		1300	undef $${$_[0]};
1057	}	1301	}
1058		1302
1059	package AnyEvent::CondVar;	1303	package AnyEvent::CondVar;
1060		1304
1061	our @ISA = AnyEvent::CondVar::Base::;	1305	our @ISA = AnyEvent::CondVar::Base::;
…		…
1113	}	1357	}
1114		1358
1115	# undocumented/compatibility with pre-3.4	1359	# undocumented/compatibility with pre-3.4
1116	*broadcast = \&send;	1360	*broadcast = \&send;
1117	*wait = \&_wait;	1361	*wait = \&_wait;
		1362
		1363	=head1 ERROR AND EXCEPTION HANDLING
		1364
		1365	In general, AnyEvent does not do any error handling - it relies on the
		1366	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1367	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1368	checking of all AnyEvent methods, however, which is highly useful during
		1369	development.
		1370
		1371	As for exception handling (i.e. runtime errors and exceptions thrown while
		1372	executing a callback), this is not only highly event-loop specific, but
		1373	also not in any way wrapped by this module, as this is the job of the main
		1374	program.
		1375
		1376	The pure perl event loop simply re-throws the exception (usually
		1377	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1378	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1379	so on.
		1380
		1381	=head1 ENVIRONMENT VARIABLES
		1382
		1383	The following environment variables are used by this module or its
		1384	submodules.
		1385
		1386	Note that AnyEvent will remove I<all> environment variables starting with
		1387	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1388	enabled.
		1389
		1390	=over 4
		1391
		1392	=item C<PERL_ANYEVENT_VERBOSE>
		1393
		1394	By default, AnyEvent will be completely silent except in fatal
		1395	conditions. You can set this environment variable to make AnyEvent more
		1396	talkative.
		1397
		1398	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1399	conditions, such as not being able to load the event model specified by
		1400	C<PERL_ANYEVENT_MODEL>.
		1401
		1402	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1403	model it chooses.
		1404
		1405	=item C<PERL_ANYEVENT_STRICT>
		1406
		1407	AnyEvent does not do much argument checking by default, as thorough
		1408	argument checking is very costly. Setting this variable to a true value
		1409	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1410	check the arguments passed to most method calls. If it finds any problems,
		1411	it will croak.
		1412
		1413	In other words, enables "strict" mode.
		1414
		1415	Unlike C<use strict>, it is definitely recommended to keep it off in
		1416	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
		1417	developing programs can be very useful, however.
		1418
		1419	=item C<PERL_ANYEVENT_MODEL>
		1420
		1421	This can be used to specify the event model to be used by AnyEvent, before
		1422	auto detection and -probing kicks in. It must be a string consisting
		1423	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1424	and the resulting module name is loaded and if the load was successful,
		1425	used as event model. If it fails to load AnyEvent will proceed with
		1426	auto detection and -probing.
		1427
		1428	This functionality might change in future versions.
		1429
		1430	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1431	could start your program like this:
		1432
		1433	PERL_ANYEVENT_MODEL=Perl perl ...
		1434
		1435	=item C<PERL_ANYEVENT_PROTOCOLS>
		1436
		1437	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1438	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1439	of auto probing).
		1440
		1441	Must be set to a comma-separated list of protocols or address families,
		1442	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1443	used, and preference will be given to protocols mentioned earlier in the
		1444	list.
		1445
		1446	This variable can effectively be used for denial-of-service attacks
		1447	against local programs (e.g. when setuid), although the impact is likely
		1448	small, as the program has to handle conenction and other failures anyways.
		1449
		1450	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1451	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1452	- only support IPv4, never try to resolve or contact IPv6
		1453	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1454	IPv6, but prefer IPv6 over IPv4.
		1455
		1456	=item C<PERL_ANYEVENT_EDNS0>
		1457
		1458	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1459	for DNS. This extension is generally useful to reduce DNS traffic, but
		1460	some (broken) firewalls drop such DNS packets, which is why it is off by
		1461	default.
		1462
		1463	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1464	EDNS0 in its DNS requests.
		1465
		1466	=item C<PERL_ANYEVENT_MAX_FORKS>
		1467
		1468	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1469	will create in parallel.
		1470
		1471	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1472
		1473	The default value for the C<max_outstanding> parameter for the default DNS
		1474	resolver - this is the maximum number of parallel DNS requests that are
		1475	sent to the DNS server.
		1476
		1477	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1478
		1479	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1480	configuration) in the default resolver. When set to the empty string, no
		1481	default config will be used.
		1482
		1483	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1484
		1485	When neither C<ca_file> nor C<ca_path> was specified during
		1486	L<AnyEvent::TLS> context creation, and either of these environment
		1487	variables exist, they will be used to specify CA certificate locations
		1488	instead of a system-dependent default.
		1489
		1490	=back
1118		1491
1119	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1492	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1120		1493
1121	This is an advanced topic that you do not normally need to use AnyEvent in	1494	This is an advanced topic that you do not normally need to use AnyEvent in
1122	a module. This section is only of use to event loop authors who want to	1495	a module. This section is only of use to event loop authors who want to
…		…
1156		1529
1157	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1530	I<rxvt-unicode> also cheats a bit by not providing blocking access to
1158	condition variables: code blocking while waiting for a condition will	1531	condition variables: code blocking while waiting for a condition will
1159	C<die>. This still works with most modules/usages, and blocking calls must	1532	C<die>. This still works with most modules/usages, and blocking calls must
1160	not be done in an interactive application, so it makes sense.	1533	not be done in an interactive application, so it makes sense.
1161
1162	=head1 ENVIRONMENT VARIABLES
1163
1164	The following environment variables are used by this module:
1165
1166	=over 4
1167
1168	=item C<PERL_ANYEVENT_VERBOSE>
1169
1170	By default, AnyEvent will be completely silent except in fatal
1171	conditions. You can set this environment variable to make AnyEvent more
1172	talkative.
1173
1174	When set to C<1> or higher, causes AnyEvent to warn about unexpected
1175	conditions, such as not being able to load the event model specified by
1176	C<PERL_ANYEVENT_MODEL>.
1177
1178	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1179	model it chooses.
1180
1181	=item C<PERL_ANYEVENT_MODEL>
1182
1183	This can be used to specify the event model to be used by AnyEvent, before
1184	auto detection and -probing kicks in. It must be a string consisting
1185	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1186	and the resulting module name is loaded and if the load was successful,
1187	used as event model. If it fails to load AnyEvent will proceed with
1188	auto detection and -probing.
1189
1190	This functionality might change in future versions.
1191
1192	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1193	could start your program like this:
1194
1195	PERL_ANYEVENT_MODEL=Perl perl ...
1196
1197	=item C<PERL_ANYEVENT_PROTOCOLS>
1198
1199	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1200	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1201	of auto probing).
1202
1203	Must be set to a comma-separated list of protocols or address families,
1204	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1205	used, and preference will be given to protocols mentioned earlier in the
1206	list.
1207
1208	This variable can effectively be used for denial-of-service attacks
1209	against local programs (e.g. when setuid), although the impact is likely
1210	small, as the program has to handle connection errors already-
1211
1212	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1213	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1214	- only support IPv4, never try to resolve or contact IPv6
1215	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1216	IPv6, but prefer IPv6 over IPv4.
1217
1218	=item C<PERL_ANYEVENT_EDNS0>
1219
1220	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1221	for DNS. This extension is generally useful to reduce DNS traffic, but
1222	some (broken) firewalls drop such DNS packets, which is why it is off by
1223	default.
1224
1225	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1226	EDNS0 in its DNS requests.
1227
1228	=item C<PERL_ANYEVENT_MAX_FORKS>
1229
1230	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1231	will create in parallel.
1232
1233	=back
1234		1534
1235	=head1 EXAMPLE PROGRAM	1535	=head1 EXAMPLE PROGRAM
1236		1536
1237	The following program uses an I/O watcher to read data from STDIN, a timer	1537	The following program uses an I/O watcher to read data from STDIN, a timer
1238	to display a message once per second, and a condition variable to quit the	1538	to display a message once per second, and a condition variable to quit the
…		…
1432	watcher.	1732	watcher.
1433		1733
1434	=head3 Results	1734	=head3 Results
1435		1735
1436	name watchers bytes create invoke destroy comment	1736	name watchers bytes create invoke destroy comment
1437	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1737	EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1438	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	1738	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1439	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	1739	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1440	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	1740	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1441	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	1741	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1442	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	1742	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
		1743	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
		1744	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1443	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	1745	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1444	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	1746	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1445	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	1747	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1446	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	1748	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1447		1749
1448	=head3 Discussion	1750	=head3 Discussion
1449		1751
1450	The benchmark does I<not> measure scalability of the event loop very	1752	The benchmark does I<not> measure scalability of the event loop very
1451	well. For example, a select-based event loop (such as the pure perl one)	1753	well. For example, a select-based event loop (such as the pure perl one)
…		…
1476	performance becomes really bad with lots of file descriptors (and few of	1778	performance becomes really bad with lots of file descriptors (and few of
1477	them active), of course, but this was not subject of this benchmark.	1779	them active), of course, but this was not subject of this benchmark.
1478		1780
1479	The C<Event> module has a relatively high setup and callback invocation	1781	The C<Event> module has a relatively high setup and callback invocation
1480	cost, but overall scores in on the third place.	1782	cost, but overall scores in on the third place.
		1783
		1784	C<IO::Async> performs admirably well, about on par with C<Event>, even
		1785	when using its pure perl backend.
1481		1786
1482	C<Glib>'s memory usage is quite a bit higher, but it features a	1787	C<Glib>'s memory usage is quite a bit higher, but it features a
1483	faster callback invocation and overall ends up in the same class as	1788	faster callback invocation and overall ends up in the same class as
1484	C<Event>. However, Glib scales extremely badly, doubling the number of	1789	C<Event>. However, Glib scales extremely badly, doubling the number of
1485	watchers increases the processing time by more than a factor of four,	1790	watchers increases the processing time by more than a factor of four,
…		…
1563	it to another server. This includes deleting the old timeout and creating	1868	it to another server. This includes deleting the old timeout and creating
1564	a new one that moves the timeout into the future.	1869	a new one that moves the timeout into the future.
1565		1870
1566	=head3 Results	1871	=head3 Results
1567		1872
1568	name sockets create request	1873	name sockets create request
1569	EV 20000 69.01 11.16	1874	EV 20000 69.01 11.16
1570	Perl 20000 73.32 35.87	1875	Perl 20000 73.32 35.87
		1876	IOAsync 20000 157.00 98.14 epoll
		1877	IOAsync 20000 159.31 616.06 poll
1571	Event 20000 212.62 257.32	1878	Event 20000 212.62 257.32
1572	Glib 20000 651.16 1896.30	1879	Glib 20000 651.16 1896.30
1573	POE 20000 349.67 12317.24 uses POE::Loop::Event	1880	POE 20000 349.67 12317.24 uses POE::Loop::Event
1574		1881
1575	=head3 Discussion	1882	=head3 Discussion
1576		1883
1577	This benchmark I<does> measure scalability and overall performance of the	1884	This benchmark I<does> measure scalability and overall performance of the
1578	particular event loop.	1885	particular event loop.
…		…
1580	EV is again fastest. Since it is using epoll on my system, the setup time	1887	EV is again fastest. Since it is using epoll on my system, the setup time
1581	is relatively high, though.	1888	is relatively high, though.
1582		1889
1583	Perl surprisingly comes second. It is much faster than the C-based event	1890	Perl surprisingly comes second. It is much faster than the C-based event
1584	loops Event and Glib.	1891	loops Event and Glib.
		1892
		1893	IO::Async performs very well when using its epoll backend, and still quite
		1894	good compared to Glib when using its pure perl backend.
1585		1895
1586	Event suffers from high setup time as well (look at its code and you will	1896	Event suffers from high setup time as well (look at its code and you will
1587	understand why). Callback invocation also has a high overhead compared to	1897	understand why). Callback invocation also has a high overhead compared to
1588	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	1898	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1589	uses select or poll in basically all documented configurations.	1899	uses select or poll in basically all documented configurations.
…		…
1652	=item * C-based event loops perform very well with small number of	1962	=item * C-based event loops perform very well with small number of
1653	watchers, as the management overhead dominates.	1963	watchers, as the management overhead dominates.
1654		1964
1655	=back	1965	=back
1656		1966
		1967	=head2 THE IO::Lambda BENCHMARK
		1968
		1969	Recently I was told about the benchmark in the IO::Lambda manpage, which
		1970	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		1971	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		1972	shouldn't come as a surprise to anybody). As such, the benchmark is
		1973	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		1974	very optimal. But how would AnyEvent compare when used without the extra
		1975	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		1976
		1977	The benchmark itself creates an echo-server, and then, for 500 times,
		1978	connects to the echo server, sends a line, waits for the reply, and then
		1979	creates the next connection. This is a rather bad benchmark, as it doesn't
		1980	test the efficiency of the framework or much non-blocking I/O, but it is a
		1981	benchmark nevertheless.
		1982
		1983	name runtime
		1984	Lambda/select 0.330 sec
		1985	+ optimized 0.122 sec
		1986	Lambda/AnyEvent 0.327 sec
		1987	+ optimized 0.138 sec
		1988	Raw sockets/select 0.077 sec
		1989	POE/select, components 0.662 sec
		1990	POE/select, raw sockets 0.226 sec
		1991	POE/select, optimized 0.404 sec
		1992
		1993	AnyEvent/select/nb 0.085 sec
		1994	AnyEvent/EV/nb 0.068 sec
		1995	+state machine 0.134 sec
		1996
		1997	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		1998	benchmarks actually make blocking connects and use 100% blocking I/O,
		1999	defeating the purpose of an event-based solution. All of the newly
		2000	written AnyEvent benchmarks use 100% non-blocking connects (using
		2001	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2002	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2003	generally require a lot more bookkeeping and event handling than blocking
		2004	connects (which involve a single syscall only).
		2005
		2006	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2007	offers similar expressive power as POE and IO::Lambda, using conventional
		2008	Perl syntax. This means that both the echo server and the client are 100%
		2009	non-blocking, further placing it at a disadvantage.
		2010
		2011	As you can see, the AnyEvent + EV combination even beats the
		2012	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2013	backend easily beats IO::Lambda and POE.
		2014
		2015	And even the 100% non-blocking version written using the high-level (and
		2016	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
		2017	large margin, even though it does all of DNS, tcp-connect and socket I/O
		2018	in a non-blocking way.
		2019
		2020	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2021	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2022	part of the IO::lambda distribution and were used without any changes.
		2023
		2024
		2025	=head1 SIGNALS
		2026
		2027	AnyEvent currently installs handlers for these signals:
		2028
		2029	=over 4
		2030
		2031	=item SIGCHLD
		2032
		2033	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		2034	emulation for event loops that do not support them natively. Also, some
		2035	event loops install a similar handler.
		2036
		2037	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will
		2038	reset it to default, to avoid losing child exit statuses.
		2039
		2040	=item SIGPIPE
		2041
		2042	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		2043	when AnyEvent gets loaded.
		2044
		2045	The rationale for this is that AnyEvent users usually do not really depend
		2046	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		2047	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		2048	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		2049	some random socket.
		2050
		2051	The rationale for installing a no-op handler as opposed to ignoring it is
		2052	that this way, the handler will be restored to defaults on exec.
		2053
		2054	Feel free to install your own handler, or reset it to defaults.
		2055
		2056	=back
		2057
		2058	=cut
		2059
		2060	undef $SIG{CHLD}
		2061	if $SIG{CHLD} eq 'IGNORE';
		2062
		2063	$SIG{PIPE} = sub { }
		2064	unless defined $SIG{PIPE};
1657		2065
1658	=head1 FORK	2066	=head1 FORK
1659		2067
1660	Most event libraries are not fork-safe. The ones who are usually are	2068	Most event libraries are not fork-safe. The ones who are usually are
1661	because they rely on inefficient but fork-safe C<select> or C<poll>	2069	because they rely on inefficient but fork-safe C<select> or C<poll>
…		…
1681		2089
1682	use AnyEvent;	2090	use AnyEvent;
1683		2091
1684	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2092	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1685	be used to probe what backend is used and gain other information (which is	2093	be used to probe what backend is used and gain other information (which is
1686	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	2094	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		2095	$ENV{PERL_ANYEVENT_STRICT}.
		2096
		2097	Note that AnyEvent will remove I<all> environment variables starting with
		2098	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2099	enabled.
1687		2100
1688		2101
1689	=head1 BUGS	2102	=head1 BUGS
1690		2103
1691	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2104	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1692	to work around. If you suffer from memleaks, first upgrade to Perl 5.10	2105	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1693	and check wether the leaks still show up. (Perl 5.10.0 has other annoying	2106	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1694	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as	2107	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1695	pronounced).	2108	pronounced).
1696		2109
1697		2110
1698	=head1 SEE ALSO	2111	=head1 SEE ALSO
1699		2112
…		…
1703	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2116	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1704		2117
1705	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2118	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1706	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2119	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1707	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2120	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1708	L<AnyEvent::Impl::POE>.	2121	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
1709		2122
1710	Non-blocking file handles, sockets, TCP clients and	2123	Non-blocking file handles, sockets, TCP clients and
1711	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2124	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1712		2125
1713	Asynchronous DNS: L<AnyEvent::DNS>.	2126	Asynchronous DNS: L<AnyEvent::DNS>.
1714		2127
1715	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2128	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2129	L<Coro::Event>,
1716		2130
1717	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2131	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2132	L<AnyEvent::HTTP>.
1718		2133
1719		2134
1720	=head1 AUTHOR	2135	=head1 AUTHOR
1721		2136
1722	Marc Lehmann <schmorp@schmorp.de>	2137	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.164 by root, Tue Jul 8 19:50:25 2008 UTC vs. Revision 1.231 by root, Wed Jul 8 13:46:46 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.164 by root, Tue Jul 8 19:50:25 2008 UTC vs.
Revision 1.231 by root, Wed Jul 8 13:46:46 2009 UTC