ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.165 by root, Tue Jul 8 23:07:26 2008 UTC vs.
Revision 1.247 by root, Sat Jul 18 22:24:17 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
…		…
298	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
299	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
300	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	330	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
301	account.	331	account.
302		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
303	=back	348	=back
304		349
305	=head2 SIGNAL WATCHERS	350	=head2 SIGNAL WATCHERS
306		351
307	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
308	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
309	be invoked whenever a signal occurs.	354	callback to be invoked whenever a signal occurs.
310		355
311	Although the callback might get passed parameters, their value and	356	Although the callback might get passed parameters, their value and
312	presence is undefined and you cannot rely on them. Portable AnyEvent	357	presence is undefined and you cannot rely on them. Portable AnyEvent
313	callbacks cannot use arguments passed to signal watcher callbacks.	358	callbacks cannot use arguments passed to signal watcher callbacks.
314		359
…		…
316	invocation, and callback invocation will be synchronous. Synchronous means	361	invocation, and callback invocation will be synchronous. Synchronous means
317	that it might take a while until the signal gets handled by the process,	362	that it might take a while until the signal gets handled by the process,
318	but it is guaranteed not to interrupt any other callbacks.	363	but it is guaranteed not to interrupt any other callbacks.
319		364
320	The main advantage of using these watchers is that you can share a signal	365	The main advantage of using these watchers is that you can share a signal
321	between multiple watchers.	366	between multiple watchers, and AnyEvent will ensure that signals will not
		367	interrupt your program at bad times.
322		368
323	This watcher might use C<%SIG>, so programs overwriting those signals	369	This watcher might use C<%SIG> (depending on the event loop used),
324	directly will likely not work correctly.	370	so programs overwriting those signals directly will likely not work
		371	correctly.
325		372
326	Example: exit on SIGINT	373	Example: exit on SIGINT
327		374
328	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	375	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
329		376
		377	=head3 Signal Races, Delays and Workarounds
		378
		379	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		380	callbacks to signals in a generic way, which is a pity, as you cannot do
		381	race-free signal handling in perl. AnyEvent will try to do it's best, but
		382	in some cases, signals will be delayed. The maximum time a signal might
		383	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
		384	seconds). This variable can be changed only before the first signal
		385	watcher is created, and should be left alone otherwise. Higher values
		386	will cause fewer spurious wake-ups, which is better for power and CPU
		387	saving. All these problems can be avoided by installing the optional
		388	L<Async::Interrupt> module. This will not work with inherently broken
		389	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
		390	currently, as POE does it's own workaround with one-second latency). With
		391	those, you just have to suffer the delays.
		392
330	=head2 CHILD PROCESS WATCHERS	393	=head2 CHILD PROCESS WATCHERS
331		394
332	You can also watch on a child process exit and catch its exit status.	395	You can also watch on a child process exit and catch its exit status.
333		396
334	The child process is specified by the C<pid> argument (if set to C<0>, it	397	The child process is specified by the C<pid> argument (if set to C<0>, it
335	watches for any child process exit). The watcher will trigger as often	398	watches for any child process exit). The watcher will triggered only when
336	as status change for the child are received. This works by installing a	399	the child process has finished and an exit status is available, not on
337	signal handler for C<SIGCHLD>. The callback will be called with the pid	400	any trace events (stopped/continued).
338	and exit status (as returned by waitpid), so unlike other watcher types,	401
339	you I<can> rely on child watcher callback arguments.	402	The callback will be called with the pid and exit status (as returned by
		403	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		404	callback arguments.
		405
		406	This watcher type works by installing a signal handler for C<SIGCHLD>,
		407	and since it cannot be shared, nothing else should use SIGCHLD or reap
		408	random child processes (waiting for specific child processes, e.g. inside
		409	C<system>, is just fine).
340		410
341	There is a slight catch to child watchers, however: you usually start them	411	There is a slight catch to child watchers, however: you usually start them
342	I<after> the child process was created, and this means the process could	412	I<after> the child process was created, and this means the process could
343	have exited already (and no SIGCHLD will be sent anymore).	413	have exited already (and no SIGCHLD will be sent anymore).
344		414
345	Not all event models handle this correctly (POE doesn't), but even for	415	Not all event models handle this correctly (neither POE nor IO::Async do,
		416	see their AnyEvent::Impl manpages for details), but even for event models
346	event models that I<do> handle this correctly, they usually need to be	417	that I<do> handle this correctly, they usually need to be loaded before
347	loaded before the process exits (i.e. before you fork in the first place).	418	the process exits (i.e. before you fork in the first place). AnyEvent's
		419	pure perl event loop handles all cases correctly regardless of when you
		420	start the watcher.
348		421
349	This means you cannot create a child watcher as the very first thing in an	422	This means you cannot create a child watcher as the very first
350	AnyEvent program, you I<have> to create at least one watcher before you	423	thing in an AnyEvent program, you I<have> to create at least one
351	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	424	watcher before you C<fork> the child (alternatively, you can call
		425	C<AnyEvent::detect>).
		426
		427	As most event loops do not support waiting for child events, they will be
		428	emulated by AnyEvent in most cases, in which the latency and race problems
		429	mentioned in the description of signal watchers apply.
352		430
353	Example: fork a process and wait for it	431	Example: fork a process and wait for it
354		432
355	my $done = AnyEvent->condvar;	433	my $done = AnyEvent->condvar;
356		434
…		…
366	);	444	);
367		445
368	# do something else, then wait for process exit	446	# do something else, then wait for process exit
369	$done->recv;	447	$done->recv;
370		448
		449	=head2 IDLE WATCHERS
		450
		451	Sometimes there is a need to do something, but it is not so important
		452	to do it instantly, but only when there is nothing better to do. This
		453	"nothing better to do" is usually defined to be "no other events need
		454	attention by the event loop".
		455
		456	Idle watchers ideally get invoked when the event loop has nothing
		457	better to do, just before it would block the process to wait for new
		458	events. Instead of blocking, the idle watcher is invoked.
		459
		460	Most event loops unfortunately do not really support idle watchers (only
		461	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		462	will simply call the callback "from time to time".
		463
		464	Example: read lines from STDIN, but only process them when the
		465	program is otherwise idle:
		466
		467	my @lines; # read data
		468	my $idle_w;
		469	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		470	push @lines, scalar <STDIN>;
		471
		472	# start an idle watcher, if not already done
		473	$idle_w ||= AnyEvent->idle (cb => sub {
		474	# handle only one line, when there are lines left
		475	if (my $line = shift @lines) {
		476	print "handled when idle: $line";
		477	} else {
		478	# otherwise disable the idle watcher again
		479	undef $idle_w;
		480	}
		481	});
		482	});
		483
371	=head2 CONDITION VARIABLES	484	=head2 CONDITION VARIABLES
372		485
373	If you are familiar with some event loops you will know that all of them	486	If you are familiar with some event loops you will know that all of them
374	require you to run some blocking "loop", "run" or similar function that	487	require you to run some blocking "loop", "run" or similar function that
375	will actively watch for new events and call your callbacks.	488	will actively watch for new events and call your callbacks.
376		489
377	AnyEvent is different, it expects somebody else to run the event loop and	490	AnyEvent is slightly different: it expects somebody else to run the event
378	will only block when necessary (usually when told by the user).	491	loop and will only block when necessary (usually when told by the user).
379		492
380	The instrument to do that is called a "condition variable", so called	493	The instrument to do that is called a "condition variable", so called
381	because they represent a condition that must become true.	494	because they represent a condition that must become true.
		495
		496	Now is probably a good time to look at the examples further below.
382		497
383	Condition variables can be created by calling the C<< AnyEvent->condvar	498	Condition variables can be created by calling the C<< AnyEvent->condvar
384	>> method, usually without arguments. The only argument pair allowed is	499	>> method, usually without arguments. The only argument pair allowed is
385	C<cb>, which specifies a callback to be called when the condition variable	500	C<cb>, which specifies a callback to be called when the condition variable
386	becomes true.	501	becomes true, with the condition variable as the first argument (but not
		502	the results).
387		503
388	After creation, the condition variable is "false" until it becomes "true"	504	After creation, the condition variable is "false" until it becomes "true"
389	by calling the C<send> method (or calling the condition variable as if it	505	by calling the C<send> method (or calling the condition variable as if it
390	were a callback, read about the caveats in the description for the C<<	506	were a callback, read about the caveats in the description for the C<<
391	->send >> method).	507	->send >> method).
…		…
437	after => 1,	553	after => 1,
438	cb => sub { $result_ready->send },	554	cb => sub { $result_ready->send },
439	);	555	);
440		556
441	# this "blocks" (while handling events) till the callback	557	# this "blocks" (while handling events) till the callback
442	# calls send	558	# calls -<send
443	$result_ready->recv;	559	$result_ready->recv;
444		560
445	Example: wait for a timer, but take advantage of the fact that	561	Example: wait for a timer, but take advantage of the fact that condition
446	condition variables are also code references.	562	variables are also callable directly.
447		563
448	my $done = AnyEvent->condvar;	564	my $done = AnyEvent->condvar;
449	my $delay = AnyEvent->timer (after => 5, cb => $done);	565	my $delay = AnyEvent->timer (after => 5, cb => $done);
450	$done->recv;	566	$done->recv;
		567
		568	Example: Imagine an API that returns a condvar and doesn't support
		569	callbacks. This is how you make a synchronous call, for example from
		570	the main program:
		571
		572	use AnyEvent::CouchDB;
		573
		574	...
		575
		576	my @info = $couchdb->info->recv;
		577
		578	And this is how you would just set a callback to be called whenever the
		579	results are available:
		580
		581	$couchdb->info->cb (sub {
		582	my @info = $_[0]->recv;
		583	});
451		584
452	=head3 METHODS FOR PRODUCERS	585	=head3 METHODS FOR PRODUCERS
453		586
454	These methods should only be used by the producing side, i.e. the	587	These methods should only be used by the producing side, i.e. the
455	code/module that eventually sends the signal. Note that it is also	588	code/module that eventually sends the signal. Note that it is also
…		…
468	immediately from within send.	601	immediately from within send.
469		602
470	Any arguments passed to the C<send> call will be returned by all	603	Any arguments passed to the C<send> call will be returned by all
471	future C<< ->recv >> calls.	604	future C<< ->recv >> calls.
472		605
473	Condition variables are overloaded so one can call them directly	606	Condition variables are overloaded so one can call them directly (as if
474	(as a code reference). Calling them directly is the same as calling	607	they were a code reference). Calling them directly is the same as calling
475	C<send>. Note, however, that many C-based event loops do not handle	608	C<send>.
476	overloading, so as tempting as it may be, passing a condition variable
477	instead of a callback does not work. Both the pure perl and EV loops
478	support overloading, however, as well as all functions that use perl to
479	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
480	example).
481		609
482	=item $cv->croak ($error)	610	=item $cv->croak ($error)
483		611
484	Similar to send, but causes all call's to C<< ->recv >> to invoke	612	Similar to send, but causes all call's to C<< ->recv >> to invoke
485	C<Carp::croak> with the given error message/object/scalar.	613	C<Carp::croak> with the given error message/object/scalar.
486		614
487	This can be used to signal any errors to the condition variable	615	This can be used to signal any errors to the condition variable
488	user/consumer.	616	user/consumer. Doing it this way instead of calling C<croak> directly
		617	delays the error detetcion, but has the overwhelmign advantage that it
		618	diagnoses the error at the place where the result is expected, and not
		619	deep in some event clalback without connection to the actual code causing
		620	the problem.
489		621
490	=item $cv->begin ([group callback])	622	=item $cv->begin ([group callback])
491		623
492	=item $cv->end	624	=item $cv->end
493
494	These two methods are EXPERIMENTAL and MIGHT CHANGE.
495		625
496	These two methods can be used to combine many transactions/events into	626	These two methods can be used to combine many transactions/events into
497	one. For example, a function that pings many hosts in parallel might want	627	one. For example, a function that pings many hosts in parallel might want
498	to use a condition variable for the whole process.	628	to use a condition variable for the whole process.
499		629
…		…
501	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	631	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
502	>>, the (last) callback passed to C<begin> will be executed. That callback	632	>>, the (last) callback passed to C<begin> will be executed. That callback
503	is I<supposed> to call C<< ->send >>, but that is not required. If no	633	is I<supposed> to call C<< ->send >>, but that is not required. If no
504	callback was set, C<send> will be called without any arguments.	634	callback was set, C<send> will be called without any arguments.
505		635
506	Let's clarify this with the ping example:	636	You can think of C<< $cv->send >> giving you an OR condition (one call
		637	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		638	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		639
		640	Let's start with a simple example: you have two I/O watchers (for example,
		641	STDOUT and STDERR for a program), and you want to wait for both streams to
		642	close before activating a condvar:
		643
		644	my $cv = AnyEvent->condvar;
		645
		646	$cv->begin; # first watcher
		647	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		648	defined sysread $fh1, my $buf, 4096
		649	or $cv->end;
		650	});
		651
		652	$cv->begin; # second watcher
		653	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		654	defined sysread $fh2, my $buf, 4096
		655	or $cv->end;
		656	});
		657
		658	$cv->recv;
		659
		660	This works because for every event source (EOF on file handle), there is
		661	one call to C<begin>, so the condvar waits for all calls to C<end> before
		662	sending.
		663
		664	The ping example mentioned above is slightly more complicated, as the
		665	there are results to be passwd back, and the number of tasks that are
		666	begung can potentially be zero:
507		667
508	my $cv = AnyEvent->condvar;	668	my $cv = AnyEvent->condvar;
509		669
510	my %result;	670	my %result;
511	$cv->begin (sub { $cv->send (\%result) });	671	$cv->begin (sub { $cv->send (\%result) });
…		…
531	loop, which serves two important purposes: first, it sets the callback	691	loop, which serves two important purposes: first, it sets the callback
532	to be called once the counter reaches C<0>, and second, it ensures that	692	to be called once the counter reaches C<0>, and second, it ensures that
533	C<send> is called even when C<no> hosts are being pinged (the loop	693	C<send> is called even when C<no> hosts are being pinged (the loop
534	doesn't execute once).	694	doesn't execute once).
535		695
536	This is the general pattern when you "fan out" into multiple subrequests:	696	This is the general pattern when you "fan out" into multiple (but
537	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	697	potentially none) subrequests: use an outer C<begin>/C<end> pair to set
538	is called at least once, and then, for each subrequest you start, call	698	the callback and ensure C<end> is called at least once, and then, for each
539	C<begin> and for each subrequest you finish, call C<end>.	699	subrequest you start, call C<begin> and for each subrequest you finish,
		700	call C<end>.
540		701
541	=back	702	=back
542		703
543	=head3 METHODS FOR CONSUMERS	704	=head3 METHODS FOR CONSUMERS
544		705
…		…
560	function will call C<croak>.	721	function will call C<croak>.
561		722
562	In list context, all parameters passed to C<send> will be returned,	723	In list context, all parameters passed to C<send> will be returned,
563	in scalar context only the first one will be returned.	724	in scalar context only the first one will be returned.
564		725
		726	Note that doing a blocking wait in a callback is not supported by any
		727	event loop, that is, recursive invocation of a blocking C<< ->recv
		728	>> is not allowed, and the C<recv> call will C<croak> if such a
		729	condition is detected. This condition can be slightly loosened by using
		730	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		731	any thread that doesn't run the event loop itself.
		732
565	Not all event models support a blocking wait - some die in that case	733	Not all event models support a blocking wait - some die in that case
566	(programs might want to do that to stay interactive), so I<if you are	734	(programs might want to do that to stay interactive), so I<if you are
567	using this from a module, never require a blocking wait>, but let the	735	using this from a module, never require a blocking wait>. Instead, let the
568	caller decide whether the call will block or not (for example, by coupling	736	caller decide whether the call will block or not (for example, by coupling
569	condition variables with some kind of request results and supporting	737	condition variables with some kind of request results and supporting
570	callbacks so the caller knows that getting the result will not block,	738	callbacks so the caller knows that getting the result will not block,
571	while still supporting blocking waits if the caller so desires).	739	while still supporting blocking waits if the caller so desires).
572		740
573	Another reason I<never> to C<< ->recv >> in a module is that you cannot
574	sensibly have two C<< ->recv >>'s in parallel, as that would require
575	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
576	can supply.
577
578	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
579	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
580	versions and also integrates coroutines into AnyEvent, making blocking
581	C<< ->recv >> calls perfectly safe as long as they are done from another
582	coroutine (one that doesn't run the event loop).
583
584	You can ensure that C<< -recv >> never blocks by setting a callback and	741	You can ensure that C<< -recv >> never blocks by setting a callback and
585	only calling C<< ->recv >> from within that callback (or at a later	742	only calling C<< ->recv >> from within that callback (or at a later
586	time). This will work even when the event loop does not support blocking	743	time). This will work even when the event loop does not support blocking
587	waits otherwise.	744	waits otherwise.
588		745
589	=item $bool = $cv->ready	746	=item $bool = $cv->ready
590		747
591	Returns true when the condition is "true", i.e. whether C<send> or	748	Returns true when the condition is "true", i.e. whether C<send> or
592	C<croak> have been called.	749	C<croak> have been called.
593		750
594	=item $cb = $cv->cb ([new callback])	751	=item $cb = $cv->cb ($cb->($cv))
595		752
596	This is a mutator function that returns the callback set and optionally	753	This is a mutator function that returns the callback set and optionally
597	replaces it before doing so.	754	replaces it before doing so.
598		755
599	The callback will be called when the condition becomes "true", i.e. when	756	The callback will be called when the condition becomes "true", i.e. when
…		…
601	variable itself. Calling C<recv> inside the callback or at any later time	758	variable itself. Calling C<recv> inside the callback or at any later time
602	is guaranteed not to block.	759	is guaranteed not to block.
603		760
604	=back	761	=back
605		762
		763	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		764
		765	The available backend classes are (every class has its own manpage):
		766
		767	=over 4
		768
		769	=item Backends that are autoprobed when no other event loop can be found.
		770
		771	EV is the preferred backend when no other event loop seems to be in
		772	use. If EV is not installed, then AnyEvent will try Event, and, failing
		773	that, will fall back to its own pure-perl implementation, which is
		774	available everywhere as it comes with AnyEvent itself.
		775
		776	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		777	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		778	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		779
		780	=item Backends that are transparently being picked up when they are used.
		781
		782	These will be used when they are currently loaded when the first watcher
		783	is created, in which case it is assumed that the application is using
		784	them. This means that AnyEvent will automatically pick the right backend
		785	when the main program loads an event module before anything starts to
		786	create watchers. Nothing special needs to be done by the main program.
		787
		788	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		789	AnyEvent::Impl::Tk based on Tk, very broken.
		790	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		791	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		792
		793	=item Backends with special needs.
		794
		795	Qt requires the Qt::Application to be instantiated first, but will
		796	otherwise be picked up automatically. As long as the main program
		797	instantiates the application before any AnyEvent watchers are created,
		798	everything should just work.
		799
		800	AnyEvent::Impl::Qt based on Qt.
		801
		802	Support for IO::Async can only be partial, as it is too broken and
		803	architecturally limited to even support the AnyEvent API. It also
		804	is the only event loop that needs the loop to be set explicitly, so
		805	it can only be used by a main program knowing about AnyEvent. See
		806	L<AnyEvent::Impl::Async> for the gory details.
		807
		808	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		809
		810	=item Event loops that are indirectly supported via other backends.
		811
		812	Some event loops can be supported via other modules:
		813
		814	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		815
		816	B<WxWidgets> has no support for watching file handles. However, you can
		817	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		818	polls 20 times per second, which was considered to be too horrible to even
		819	consider for AnyEvent.
		820
		821	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		822	backend, so it can be supported through POE.
		823
		824	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		825	load L<POE> when detecting them, in the hope that POE will pick them up,
		826	in which case everything will be automatic.
		827
		828	=back
		829
606	=head1 GLOBAL VARIABLES AND FUNCTIONS	830	=head1 GLOBAL VARIABLES AND FUNCTIONS
607		831
		832	These are not normally required to use AnyEvent, but can be useful to
		833	write AnyEvent extension modules.
		834
608	=over 4	835	=over 4
609		836
610	=item $AnyEvent::MODEL	837	=item $AnyEvent::MODEL
611		838
612	Contains C<undef> until the first watcher is being created. Then it	839	Contains C<undef> until the first watcher is being created, before the
		840	backend has been autodetected.
		841
613	contains the event model that is being used, which is the name of the	842	Afterwards it contains the event model that is being used, which is the
614	Perl class implementing the model. This class is usually one of the	843	name of the Perl class implementing the model. This class is usually one
615	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	844	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
616	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	845	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
617		846	will be C<urxvt::anyevent>).
618	The known classes so far are:
619
620	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
621	AnyEvent::Impl::Event based on Event, second best choice.
622	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
623	AnyEvent::Impl::Glib based on Glib, third-best choice.
624	AnyEvent::Impl::Tk based on Tk, very bad choice.
625	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
626	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
627	AnyEvent::Impl::POE based on POE, not generic enough for full support.
628
629	There is no support for WxWidgets, as WxWidgets has no support for
630	watching file handles. However, you can use WxWidgets through the
631	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
632	second, which was considered to be too horrible to even consider for
633	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
634	it's adaptor.
635
636	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
637	autodetecting them.
638		847
639	=item AnyEvent::detect	848	=item AnyEvent::detect
640		849
641	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	850	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
642	if necessary. You should only call this function right before you would	851	if necessary. You should only call this function right before you would
643	have created an AnyEvent watcher anyway, that is, as late as possible at	852	have created an AnyEvent watcher anyway, that is, as late as possible at
644	runtime.	853	runtime, and not e.g. while initialising of your module.
		854
		855	If you need to do some initialisation before AnyEvent watchers are
		856	created, use C<post_detect>.
645		857
646	=item $guard = AnyEvent::post_detect { BLOCK }	858	=item $guard = AnyEvent::post_detect { BLOCK }
647		859
648	Arranges for the code block to be executed as soon as the event model is	860	Arranges for the code block to be executed as soon as the event model is
649	autodetected (or immediately if this has already happened).	861	autodetected (or immediately if this has already happened).
		862
		863	The block will be executed I<after> the actual backend has been detected
		864	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		865	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		866	other initialisations - see the sources of L<AnyEvent::Strict> or
		867	L<AnyEvent::AIO> to see how this is used.
		868
		869	The most common usage is to create some global watchers, without forcing
		870	event module detection too early, for example, L<AnyEvent::AIO> creates
		871	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		872	avoid autodetecting the event module at load time.
650		873
651	If called in scalar or list context, then it creates and returns an object	874	If called in scalar or list context, then it creates and returns an object
652	that automatically removes the callback again when it is destroyed. See	875	that automatically removes the callback again when it is destroyed. See
653	L<Coro::BDB> for a case where this is useful.	876	L<Coro::BDB> for a case where this is useful.
654		877
…		…
657	If there are any code references in this array (you can C<push> to it	880	If there are any code references in this array (you can C<push> to it
658	before or after loading AnyEvent), then they will called directly after	881	before or after loading AnyEvent), then they will called directly after
659	the event loop has been chosen.	882	the event loop has been chosen.
660		883
661	You should check C<$AnyEvent::MODEL> before adding to this array, though:	884	You should check C<$AnyEvent::MODEL> before adding to this array, though:
662	if it contains a true value then the event loop has already been detected,	885	if it is defined then the event loop has already been detected, and the
663	and the array will be ignored.	886	array will be ignored.
664		887
665	Best use C<AnyEvent::post_detect { BLOCK }> instead.	888	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		889	it,as it takes care of these details.
		890
		891	This variable is mainly useful for modules that can do something useful
		892	when AnyEvent is used and thus want to know when it is initialised, but do
		893	not need to even load it by default. This array provides the means to hook
		894	into AnyEvent passively, without loading it.
666		895
667	=back	896	=back
668		897
669	=head1 WHAT TO DO IN A MODULE	898	=head1 WHAT TO DO IN A MODULE
670		899
…		…
725		954
726		955
727	=head1 OTHER MODULES	956	=head1 OTHER MODULES
728		957
729	The following is a non-exhaustive list of additional modules that use	958	The following is a non-exhaustive list of additional modules that use
730	AnyEvent and can therefore be mixed easily with other AnyEvent modules	959	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
731	in the same program. Some of the modules come with AnyEvent, some are	960	modules and other event loops in the same program. Some of the modules
732	available via CPAN.	961	come with AnyEvent, most are available via CPAN.
733		962
734	=over 4	963	=over 4
735		964
736	=item L<AnyEvent::Util>	965	=item L<AnyEvent::Util>
737		966
…		…
746		975
747	=item L<AnyEvent::Handle>	976	=item L<AnyEvent::Handle>
748		977
749	Provide read and write buffers, manages watchers for reads and writes,	978	Provide read and write buffers, manages watchers for reads and writes,
750	supports raw and formatted I/O, I/O queued and fully transparent and	979	supports raw and formatted I/O, I/O queued and fully transparent and
751	non-blocking SSL/TLS.	980	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
752		981
753	=item L<AnyEvent::DNS>	982	=item L<AnyEvent::DNS>
754		983
755	Provides rich asynchronous DNS resolver capabilities.	984	Provides rich asynchronous DNS resolver capabilities.
756		985
…		…
784		1013
785	=item L<AnyEvent::GPSD>	1014	=item L<AnyEvent::GPSD>
786		1015
787	A non-blocking interface to gpsd, a daemon delivering GPS information.	1016	A non-blocking interface to gpsd, a daemon delivering GPS information.
788		1017
		1018	=item L<AnyEvent::IRC>
		1019
		1020	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1021
		1022	=item L<AnyEvent::XMPP>
		1023
		1024	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1025	Net::XMPP2>.
		1026
789	=item L<AnyEvent::IGS>	1027	=item L<AnyEvent::IGS>
790		1028
791	A non-blocking interface to the Internet Go Server protocol (used by	1029	A non-blocking interface to the Internet Go Server protocol (used by
792	L<App::IGS>).	1030	L<App::IGS>).
793		1031
794	=item L<Net::IRC3>
795
796	AnyEvent based IRC client module family.
797
798	=item L<Net::XMPP2>
799
800	AnyEvent based XMPP (Jabber protocol) module family.
801
802	=item L<Net::FCP>	1032	=item L<Net::FCP>
803		1033
804	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1034	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
805	of AnyEvent.	1035	of AnyEvent.
806		1036
…		…
810		1040
811	=item L<Coro>	1041	=item L<Coro>
812		1042
813	Has special support for AnyEvent via L<Coro::AnyEvent>.	1043	Has special support for AnyEvent via L<Coro::AnyEvent>.
814		1044
815	=item L<IO::Lambda>
816
817	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
818
819	=back	1045	=back
820		1046
821	=cut	1047	=cut
822		1048
823	package AnyEvent;	1049	package AnyEvent;
824		1050
		1051	# basically a tuned-down version of common::sense
		1052	sub common_sense {
825	no warnings;	1053	# no warnings
826	use strict;	1054	${^WARNING_BITS} ^= ${^WARNING_BITS};
		1055	# use strict vars subs
		1056	$^H |= 0x00000600;
		1057	}
827		1058
		1059	BEGIN { AnyEvent::common_sense }
		1060
828	use Carp;	1061	use Carp ();
829		1062
830	our $VERSION = 4.2;	1063	our $VERSION = 4.85;
831	our $MODEL;	1064	our $MODEL;
832		1065
833	our $AUTOLOAD;	1066	our $AUTOLOAD;
834	our @ISA;	1067	our @ISA;
835		1068
836	our @REGISTRY;	1069	our @REGISTRY;
837		1070
838	our $WIN32;	1071	our $WIN32;
839		1072
		1073	our $VERBOSE;
		1074
840	BEGIN {	1075	BEGIN {
841	my $win32 = ! ! ($^O =~ /mswin32/i);	1076	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
842	eval "sub WIN32(){ $win32 }";	1077	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
843	}
844		1078
		1079	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1080	if ${^TAINT};
		1081
845	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1082	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1083
		1084	}
		1085
		1086	our $MAX_SIGNAL_LATENCY = 10;
846		1087
847	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1088	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
848		1089
849	{	1090	{
850	my $idx;	1091	my $idx;
…		…
858	[Event:: => AnyEvent::Impl::Event::],	1099	[Event:: => AnyEvent::Impl::Event::],
859	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1100	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
860	# everything below here will not be autoprobed	1101	# everything below here will not be autoprobed
861	# as the pureperl backend should work everywhere	1102	# as the pureperl backend should work everywhere
862	# and is usually faster	1103	# and is usually faster
863	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
864	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1104	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
865	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1105	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1106	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
866	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1107	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
867	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1108	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
868	[Wx:: => AnyEvent::Impl::POE::],	1109	[Wx:: => AnyEvent::Impl::POE::],
869	[Prima:: => AnyEvent::Impl::POE::],	1110	[Prima:: => AnyEvent::Impl::POE::],
		1111	# IO::Async is just too broken - we would need workarounds for its
		1112	# byzantine signal and broken child handling, among others.
		1113	# IO::Async is rather hard to detect, as it doesn't have any
		1114	# obvious default class.
		1115	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1116	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1117	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
870	);	1118	);
871		1119
872	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1120	our %method = map +($_ => 1),
		1121	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
873		1122
874	our @post_detect;	1123	our @post_detect;
875		1124
876	sub post_detect(&) {	1125	sub post_detect(&) {
877	my ($cb) = @_;	1126	my ($cb) = @_;
…		…
882	1	1131	1
883	} else {	1132	} else {
884	push @post_detect, $cb;	1133	push @post_detect, $cb;
885		1134
886	defined wantarray	1135	defined wantarray
887	? bless \$cb, "AnyEvent::Util::PostDetect"	1136	? bless \$cb, "AnyEvent::Util::postdetect"
888	: ()	1137	: ()
889	}	1138	}
890	}	1139	}
891		1140
892	sub AnyEvent::Util::PostDetect::DESTROY {	1141	sub AnyEvent::Util::postdetect::DESTROY {
893	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1142	@post_detect = grep $_ != ${$_[0]}, @post_detect;
894	}	1143	}
895		1144
896	sub detect() {	1145	sub detect() {
897	unless ($MODEL) {	1146	unless ($MODEL) {
898	no strict 'refs';
899	local $SIG{__DIE__};	1147	local $SIG{__DIE__};
900		1148
901	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1149	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
902	my $model = "AnyEvent::Impl::$1";	1150	my $model = "AnyEvent::Impl::$1";
903	if (eval "require $model") {	1151	if (eval "require $model") {
904	$MODEL = $model;	1152	$MODEL = $model;
905	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1153	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
906	} else {	1154	} else {
907	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1155	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
908	}	1156	}
909	}	1157	}
910		1158
911	# check for already loaded models	1159	# check for already loaded models
912	unless ($MODEL) {	1160	unless ($MODEL) {
913	for (@REGISTRY, @models) {	1161	for (@REGISTRY, @models) {
914	my ($package, $model) = @$_;	1162	my ($package, $model) = @$_;
915	if (${"$package\::VERSION"} > 0) {	1163	if (${"$package\::VERSION"} > 0) {
916	if (eval "require $model") {	1164	if (eval "require $model") {
917	$MODEL = $model;	1165	$MODEL = $model;
918	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1166	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
919	last;	1167	last;
920	}	1168	}
921	}	1169	}
922	}	1170	}
923		1171
…		…
928	my ($package, $model) = @$_;	1176	my ($package, $model) = @$_;
929	if (eval "require $package"	1177	if (eval "require $package"
930	and ${"$package\::VERSION"} > 0	1178	and ${"$package\::VERSION"} > 0
931	and eval "require $model") {	1179	and eval "require $model") {
932	$MODEL = $model;	1180	$MODEL = $model;
933	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1181	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
934	last;	1182	last;
935	}	1183	}
936	}	1184	}
937		1185
938	$MODEL	1186	$MODEL
939	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1187	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
940	}	1188	}
941	}	1189	}
942		1190
		1191	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1192
943	unshift @ISA, $MODEL;	1193	unshift @ISA, $MODEL;
944	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1194
		1195	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
945		1196
946	(shift @post_detect)->() while @post_detect;	1197	(shift @post_detect)->() while @post_detect;
947	}	1198	}
948		1199
949	$MODEL	1200	$MODEL
…		…
951		1202
952	sub AUTOLOAD {	1203	sub AUTOLOAD {
953	(my $func = $AUTOLOAD) =~ s/.*://;	1204	(my $func = $AUTOLOAD) =~ s/.*://;
954		1205
955	$method{$func}	1206	$method{$func}
956	or croak "$func: not a valid method for AnyEvent objects";	1207	or Carp::croak "$func: not a valid method for AnyEvent objects";
957		1208
958	detect unless $MODEL;	1209	detect unless $MODEL;
959		1210
960	my $class = shift;	1211	my $class = shift;
961	$class->$func (@_);	1212	$class->$func (@_);
962	}	1213	}
963		1214
		1215	# utility function to dup a filehandle. this is used by many backends
		1216	# to support binding more than one watcher per filehandle (they usually
		1217	# allow only one watcher per fd, so we dup it to get a different one).
		1218	sub _dupfh($$;$$) {
		1219	my ($poll, $fh, $r, $w) = @_;
		1220
		1221	# cygwin requires the fh mode to be matching, unix doesn't
		1222	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
		1223
		1224	open my $fh2, $mode, $fh
		1225	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
		1226
		1227	# we assume CLOEXEC is already set by perl in all important cases
		1228
		1229	($fh2, $rw)
		1230	}
		1231
964	package AnyEvent::Base;	1232	package AnyEvent::Base;
965		1233
966	# default implementation for now and time	1234	# default implementations for many methods
967		1235
968	use Time::HiRes ();	1236	sub _time {
		1237	# probe for availability of Time::HiRes
		1238	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1239	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
		1240	*_time = \&Time::HiRes::time;
		1241	# if (eval "use POSIX (); (POSIX::times())...
		1242	} else {
		1243	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
		1244	*_time = sub { time }; # epic fail
		1245	}
969		1246
970	sub time { Time::HiRes::time }	1247	&_time
971	sub now { Time::HiRes::time }	1248	}
		1249
		1250	sub time { _time }
		1251	sub now { _time }
		1252	sub now_update { }
972		1253
973	# default implementation for ->condvar	1254	# default implementation for ->condvar
974		1255
975	sub condvar {	1256	sub condvar {
976	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1257	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
977	}	1258	}
978		1259
979	# default implementation for ->signal	1260	# default implementation for ->signal
980		1261
981	our %SIG_CB;	1262	our $HAVE_ASYNC_INTERRUPT;
		1263	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1264	our (%SIG_ASY, %SIG_ASY_W);
		1265	our ($SIG_COUNT, $SIG_TW);
982		1266
		1267	sub _signal_exec {
		1268	$HAVE_ASYNC_INTERRUPT
		1269	? $SIGPIPE_R->drain
		1270	: sysread $SIGPIPE_R, my $dummy, 9;
		1271
		1272	while (%SIG_EV) {
		1273	for (keys %SIG_EV) {
		1274	delete $SIG_EV{$_};
		1275	$_->() for values %{ $SIG_CB{$_} || {} };
		1276	}
		1277	}
		1278	}
		1279
		1280	# install a dumym wakeupw atcher to reduce signal catching latency
		1281	sub _sig_add() {
		1282	unless ($SIG_COUNT++) {
		1283	# try to align timer on a full-second boundary, if possible
		1284	my $NOW = AnyEvent->now;
		1285
		1286	$SIG_TW = AnyEvent->timer (
		1287	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1288	interval => $MAX_SIGNAL_LATENCY,
		1289	cb => sub { }, # just for the PERL_ASYNC_CHECK
		1290	);
		1291	}
		1292	}
		1293
		1294	sub _sig_del {
		1295	undef $SIG_TW
		1296	unless --$SIG_COUNT;
		1297	}
		1298
983	sub signal {	1299	sub _signal {
984	my (undef, %arg) = @_;	1300	my (undef, %arg) = @_;
985		1301
986	my $signal = uc $arg{signal}	1302	my $signal = uc $arg{signal}
987	or Carp::croak "required option 'signal' is missing";	1303	or Carp::croak "required option 'signal' is missing";
988		1304
989	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1305	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1306
		1307	if ($HAVE_ASYNC_INTERRUPT) {
		1308	# async::interrupt
		1309
		1310	$SIG_ASY{$signal} ||= do {
		1311	my $asy = new Async::Interrupt
		1312	cb => sub { undef $SIG_EV{$signal} },
		1313	signal => $signal,
		1314	pipe => [$SIGPIPE_R->filenos],
		1315	;
		1316	$asy->pipe_autodrain (0);
		1317
		1318	$asy
		1319	};
		1320
		1321	} else {
		1322	# pure perl
		1323
990	$SIG{$signal} ||= sub {	1324	$SIG{$signal} ||= sub {
991	$_->() for values %{ $SIG_CB{$signal} || {} };	1325	local $!;
		1326	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1327	undef $SIG_EV{$signal};
		1328	};
		1329
		1330	# can't do signal processing without introducing races in pure perl,
		1331	# so limit the signal latency.
		1332	_sig_add;
992	};	1333	}
993		1334
994	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1335	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
995	}	1336	}
996		1337
		1338	sub signal {
		1339	# probe for availability of Async::Interrupt
		1340	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
		1341	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1342
		1343	$HAVE_ASYNC_INTERRUPT = 1;
		1344	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1345	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
		1346
		1347	} else {
		1348	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1349
		1350	require Fcntl;
		1351
		1352	if (AnyEvent::WIN32) {
		1353	require AnyEvent::Util;
		1354
		1355	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1356	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1357	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1358	} else {
		1359	pipe $SIGPIPE_R, $SIGPIPE_W;
		1360	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1361	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1362
		1363	# not strictly required, as $^F is normally 2, but let's make sure...
		1364	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1365	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1366	}
		1367
		1368	$SIGPIPE_R
		1369	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1370
		1371	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1372	}
		1373
		1374	*signal = \&_signal;
		1375	&signal
		1376	}
		1377
997	sub AnyEvent::Base::Signal::DESTROY {	1378	sub AnyEvent::Base::signal::DESTROY {
998	my ($signal, $cb) = @{$_[0]};	1379	my ($signal, $cb) = @{$_[0]};
999		1380
		1381	_sig_del;
		1382
1000	delete $SIG_CB{$signal}{$cb};	1383	delete $SIG_CB{$signal}{$cb};
1001		1384
		1385	$HAVE_ASYNC_INTERRUPT
		1386	? delete $SIG_ASY{$signal}
		1387	: # delete doesn't work with older perls - they then
		1388	# print weird messages, or just unconditionally exit
		1389	# instead of getting the default action.
		1390	undef $SIG{$signal}
1002	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };	1391	unless keys %{ $SIG_CB{$signal} };
1003	}	1392	}
1004		1393
1005	# default implementation for ->child	1394	# default implementation for ->child
1006		1395
1007	our %PID_CB;	1396	our %PID_CB;
1008	our $CHLD_W;	1397	our $CHLD_W;
1009	our $CHLD_DELAY_W;	1398	our $CHLD_DELAY_W;
1010	our $PID_IDLE;
1011	our $WNOHANG;	1399	our $WNOHANG;
1012		1400
1013	sub _child_wait {	1401	sub _sigchld {
1014	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1402	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
		1403	$_->($pid, $?)
1015	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1404	for values %{ $PID_CB{$pid} || {} },
1016	(values %{ $PID_CB{0} || {} });	1405	values %{ $PID_CB{0} || {} };
1017	}	1406	}
1018
1019	undef $PID_IDLE;
1020	}
1021
1022	sub _sigchld {
1023	# make sure we deliver these changes "synchronous" with the event loop.
1024	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1025	undef $CHLD_DELAY_W;
1026	&_child_wait;
1027	});
1028	}	1407	}
1029		1408
1030	sub child {	1409	sub child {
1031	my (undef, %arg) = @_;	1410	my (undef, %arg) = @_;
1032		1411
1033	defined (my $pid = $arg{pid} + 0)	1412	defined (my $pid = $arg{pid} + 0)
1034	or Carp::croak "required option 'pid' is missing";	1413	or Carp::croak "required option 'pid' is missing";
1035		1414
1036	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1415	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1037		1416
1038	unless ($WNOHANG) {	1417	# WNOHANG is almost cetrainly 1 everywhere
		1418	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
		1419	? 1
1039	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1420	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1040	}
1041		1421
1042	unless ($CHLD_W) {	1422	unless ($CHLD_W) {
1043	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1423	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1044	# child could be a zombie already, so make at least one round	1424	# child could be a zombie already, so make at least one round
1045	&_sigchld;	1425	&_sigchld;
1046	}	1426	}
1047		1427
1048	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1428	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1049	}	1429	}
1050		1430
1051	sub AnyEvent::Base::Child::DESTROY {	1431	sub AnyEvent::Base::child::DESTROY {
1052	my ($pid, $cb) = @{$_[0]};	1432	my ($pid, $cb) = @{$_[0]};
1053		1433
1054	delete $PID_CB{$pid}{$cb};	1434	delete $PID_CB{$pid}{$cb};
1055	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1435	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1056		1436
1057	undef $CHLD_W unless keys %PID_CB;	1437	undef $CHLD_W unless keys %PID_CB;
1058	}	1438	}
1059		1439
		1440	# idle emulation is done by simply using a timer, regardless
		1441	# of whether the process is idle or not, and not letting
		1442	# the callback use more than 50% of the time.
		1443	sub idle {
		1444	my (undef, %arg) = @_;
		1445
		1446	my ($cb, $w, $rcb) = $arg{cb};
		1447
		1448	$rcb = sub {
		1449	if ($cb) {
		1450	$w = _time;
		1451	&$cb;
		1452	$w = _time - $w;
		1453
		1454	# never use more then 50% of the time for the idle watcher,
		1455	# within some limits
		1456	$w = 0.0001 if $w < 0.0001;
		1457	$w = 5 if $w > 5;
		1458
		1459	$w = AnyEvent->timer (after => $w, cb => $rcb);
		1460	} else {
		1461	# clean up...
		1462	undef $w;
		1463	undef $rcb;
		1464	}
		1465	};
		1466
		1467	$w = AnyEvent->timer (after => 0.05, cb => $rcb);
		1468
		1469	bless \\$cb, "AnyEvent::Base::idle"
		1470	}
		1471
		1472	sub AnyEvent::Base::idle::DESTROY {
		1473	undef $${$_[0]};
		1474	}
		1475
1060	package AnyEvent::CondVar;	1476	package AnyEvent::CondVar;
1061		1477
1062	our @ISA = AnyEvent::CondVar::Base::;	1478	our @ISA = AnyEvent::CondVar::Base::;
1063		1479
1064	package AnyEvent::CondVar::Base;	1480	package AnyEvent::CondVar::Base;
1065		1481
1066	use overload	1482	#use overload
1067	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1483	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1068	fallback => 1;	1484	# fallback => 1;
		1485
		1486	# save 300+ kilobytes by dirtily hardcoding overloading
		1487	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1488	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1489	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1490	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1491
		1492	our $WAITING;
1069		1493
1070	sub _send {	1494	sub _send {
1071	# nop	1495	# nop
1072	}	1496	}
1073		1497
…		…
1086	sub ready {	1510	sub ready {
1087	$_[0]{_ae_sent}	1511	$_[0]{_ae_sent}
1088	}	1512	}
1089		1513
1090	sub _wait {	1514	sub _wait {
		1515	$WAITING
		1516	and !$_[0]{_ae_sent}
		1517	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1518
		1519	local $WAITING = 1;
1091	AnyEvent->one_event while !$_[0]{_ae_sent};	1520	AnyEvent->one_event while !$_[0]{_ae_sent};
1092	}	1521	}
1093		1522
1094	sub recv {	1523	sub recv {
1095	$_[0]->_wait;	1524	$_[0]->_wait;
…		…
1114	}	1543	}
1115		1544
1116	# undocumented/compatibility with pre-3.4	1545	# undocumented/compatibility with pre-3.4
1117	*broadcast = \&send;	1546	*broadcast = \&send;
1118	*wait = \&_wait;	1547	*wait = \&_wait;
		1548
		1549	=head1 ERROR AND EXCEPTION HANDLING
		1550
		1551	In general, AnyEvent does not do any error handling - it relies on the
		1552	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1553	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1554	checking of all AnyEvent methods, however, which is highly useful during
		1555	development.
		1556
		1557	As for exception handling (i.e. runtime errors and exceptions thrown while
		1558	executing a callback), this is not only highly event-loop specific, but
		1559	also not in any way wrapped by this module, as this is the job of the main
		1560	program.
		1561
		1562	The pure perl event loop simply re-throws the exception (usually
		1563	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1564	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1565	so on.
		1566
		1567	=head1 ENVIRONMENT VARIABLES
		1568
		1569	The following environment variables are used by this module or its
		1570	submodules.
		1571
		1572	Note that AnyEvent will remove I<all> environment variables starting with
		1573	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1574	enabled.
		1575
		1576	=over 4
		1577
		1578	=item C<PERL_ANYEVENT_VERBOSE>
		1579
		1580	By default, AnyEvent will be completely silent except in fatal
		1581	conditions. You can set this environment variable to make AnyEvent more
		1582	talkative.
		1583
		1584	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1585	conditions, such as not being able to load the event model specified by
		1586	C<PERL_ANYEVENT_MODEL>.
		1587
		1588	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1589	model it chooses.
		1590
		1591	When set to C<8> or higher, then AnyEvent will report extra information on
		1592	which optional modules it loads and how it implements certain features.
		1593
		1594	=item C<PERL_ANYEVENT_STRICT>
		1595
		1596	AnyEvent does not do much argument checking by default, as thorough
		1597	argument checking is very costly. Setting this variable to a true value
		1598	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1599	check the arguments passed to most method calls. If it finds any problems,
		1600	it will croak.
		1601
		1602	In other words, enables "strict" mode.
		1603
		1604	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
		1605	>>, it is definitely recommended to keep it off in production. Keeping
		1606	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1607	can be very useful, however.
		1608
		1609	=item C<PERL_ANYEVENT_MODEL>
		1610
		1611	This can be used to specify the event model to be used by AnyEvent, before
		1612	auto detection and -probing kicks in. It must be a string consisting
		1613	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1614	and the resulting module name is loaded and if the load was successful,
		1615	used as event model. If it fails to load AnyEvent will proceed with
		1616	auto detection and -probing.
		1617
		1618	This functionality might change in future versions.
		1619
		1620	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1621	could start your program like this:
		1622
		1623	PERL_ANYEVENT_MODEL=Perl perl ...
		1624
		1625	=item C<PERL_ANYEVENT_PROTOCOLS>
		1626
		1627	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1628	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1629	of auto probing).
		1630
		1631	Must be set to a comma-separated list of protocols or address families,
		1632	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1633	used, and preference will be given to protocols mentioned earlier in the
		1634	list.
		1635
		1636	This variable can effectively be used for denial-of-service attacks
		1637	against local programs (e.g. when setuid), although the impact is likely
		1638	small, as the program has to handle conenction and other failures anyways.
		1639
		1640	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1641	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1642	- only support IPv4, never try to resolve or contact IPv6
		1643	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1644	IPv6, but prefer IPv6 over IPv4.
		1645
		1646	=item C<PERL_ANYEVENT_EDNS0>
		1647
		1648	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1649	for DNS. This extension is generally useful to reduce DNS traffic, but
		1650	some (broken) firewalls drop such DNS packets, which is why it is off by
		1651	default.
		1652
		1653	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1654	EDNS0 in its DNS requests.
		1655
		1656	=item C<PERL_ANYEVENT_MAX_FORKS>
		1657
		1658	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1659	will create in parallel.
		1660
		1661	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1662
		1663	The default value for the C<max_outstanding> parameter for the default DNS
		1664	resolver - this is the maximum number of parallel DNS requests that are
		1665	sent to the DNS server.
		1666
		1667	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1668
		1669	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1670	configuration) in the default resolver. When set to the empty string, no
		1671	default config will be used.
		1672
		1673	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1674
		1675	When neither C<ca_file> nor C<ca_path> was specified during
		1676	L<AnyEvent::TLS> context creation, and either of these environment
		1677	variables exist, they will be used to specify CA certificate locations
		1678	instead of a system-dependent default.
		1679
		1680	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1681
		1682	When these are set to C<1>, then the respective modules are not
		1683	loaded. Mostly good for testing AnyEvent itself.
		1684
		1685	=back
1119		1686
1120	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1687	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1121		1688
1122	This is an advanced topic that you do not normally need to use AnyEvent in	1689	This is an advanced topic that you do not normally need to use AnyEvent in
1123	a module. This section is only of use to event loop authors who want to	1690	a module. This section is only of use to event loop authors who want to
…		…
1157		1724
1158	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1725	I<rxvt-unicode> also cheats a bit by not providing blocking access to
1159	condition variables: code blocking while waiting for a condition will	1726	condition variables: code blocking while waiting for a condition will
1160	C<die>. This still works with most modules/usages, and blocking calls must	1727	C<die>. This still works with most modules/usages, and blocking calls must
1161	not be done in an interactive application, so it makes sense.	1728	not be done in an interactive application, so it makes sense.
1162
1163	=head1 ENVIRONMENT VARIABLES
1164
1165	The following environment variables are used by this module:
1166
1167	=over 4
1168
1169	=item C<PERL_ANYEVENT_VERBOSE>
1170
1171	By default, AnyEvent will be completely silent except in fatal
1172	conditions. You can set this environment variable to make AnyEvent more
1173	talkative.
1174
1175	When set to C<1> or higher, causes AnyEvent to warn about unexpected
1176	conditions, such as not being able to load the event model specified by
1177	C<PERL_ANYEVENT_MODEL>.
1178
1179	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1180	model it chooses.
1181
1182	=item C<PERL_ANYEVENT_MODEL>
1183
1184	This can be used to specify the event model to be used by AnyEvent, before
1185	auto detection and -probing kicks in. It must be a string consisting
1186	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1187	and the resulting module name is loaded and if the load was successful,
1188	used as event model. If it fails to load AnyEvent will proceed with
1189	auto detection and -probing.
1190
1191	This functionality might change in future versions.
1192
1193	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1194	could start your program like this:
1195
1196	PERL_ANYEVENT_MODEL=Perl perl ...
1197
1198	=item C<PERL_ANYEVENT_PROTOCOLS>
1199
1200	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1201	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1202	of auto probing).
1203
1204	Must be set to a comma-separated list of protocols or address families,
1205	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1206	used, and preference will be given to protocols mentioned earlier in the
1207	list.
1208
1209	This variable can effectively be used for denial-of-service attacks
1210	against local programs (e.g. when setuid), although the impact is likely
1211	small, as the program has to handle connection errors already-
1212
1213	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1214	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1215	- only support IPv4, never try to resolve or contact IPv6
1216	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1217	IPv6, but prefer IPv6 over IPv4.
1218
1219	=item C<PERL_ANYEVENT_EDNS0>
1220
1221	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1222	for DNS. This extension is generally useful to reduce DNS traffic, but
1223	some (broken) firewalls drop such DNS packets, which is why it is off by
1224	default.
1225
1226	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1227	EDNS0 in its DNS requests.
1228
1229	=item C<PERL_ANYEVENT_MAX_FORKS>
1230
1231	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1232	will create in parallel.
1233
1234	=back
1235		1729
1236	=head1 EXAMPLE PROGRAM	1730	=head1 EXAMPLE PROGRAM
1237		1731
1238	The following program uses an I/O watcher to read data from STDIN, a timer	1732	The following program uses an I/O watcher to read data from STDIN, a timer
1239	to display a message once per second, and a condition variable to quit the	1733	to display a message once per second, and a condition variable to quit the
…		…
1433	watcher.	1927	watcher.
1434		1928
1435	=head3 Results	1929	=head3 Results
1436		1930
1437	name watchers bytes create invoke destroy comment	1931	name watchers bytes create invoke destroy comment
1438	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1932	EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1439	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	1933	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1440	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	1934	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1441	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	1935	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1442	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	1936	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1443	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	1937	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
		1938	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
		1939	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1444	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	1940	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1445	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	1941	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1446	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	1942	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1447	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	1943	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1448		1944
1449	=head3 Discussion	1945	=head3 Discussion
1450		1946
1451	The benchmark does I<not> measure scalability of the event loop very	1947	The benchmark does I<not> measure scalability of the event loop very
1452	well. For example, a select-based event loop (such as the pure perl one)	1948	well. For example, a select-based event loop (such as the pure perl one)
…		…
1477	performance becomes really bad with lots of file descriptors (and few of	1973	performance becomes really bad with lots of file descriptors (and few of
1478	them active), of course, but this was not subject of this benchmark.	1974	them active), of course, but this was not subject of this benchmark.
1479		1975
1480	The C<Event> module has a relatively high setup and callback invocation	1976	The C<Event> module has a relatively high setup and callback invocation
1481	cost, but overall scores in on the third place.	1977	cost, but overall scores in on the third place.
		1978
		1979	C<IO::Async> performs admirably well, about on par with C<Event>, even
		1980	when using its pure perl backend.
1482		1981
1483	C<Glib>'s memory usage is quite a bit higher, but it features a	1982	C<Glib>'s memory usage is quite a bit higher, but it features a
1484	faster callback invocation and overall ends up in the same class as	1983	faster callback invocation and overall ends up in the same class as
1485	C<Event>. However, Glib scales extremely badly, doubling the number of	1984	C<Event>. However, Glib scales extremely badly, doubling the number of
1486	watchers increases the processing time by more than a factor of four,	1985	watchers increases the processing time by more than a factor of four,
…		…
1564	it to another server. This includes deleting the old timeout and creating	2063	it to another server. This includes deleting the old timeout and creating
1565	a new one that moves the timeout into the future.	2064	a new one that moves the timeout into the future.
1566		2065
1567	=head3 Results	2066	=head3 Results
1568		2067
1569	name sockets create request	2068	name sockets create request
1570	EV 20000 69.01 11.16	2069	EV 20000 69.01 11.16
1571	Perl 20000 73.32 35.87	2070	Perl 20000 73.32 35.87
		2071	IOAsync 20000 157.00 98.14 epoll
		2072	IOAsync 20000 159.31 616.06 poll
1572	Event 20000 212.62 257.32	2073	Event 20000 212.62 257.32
1573	Glib 20000 651.16 1896.30	2074	Glib 20000 651.16 1896.30
1574	POE 20000 349.67 12317.24 uses POE::Loop::Event	2075	POE 20000 349.67 12317.24 uses POE::Loop::Event
1575		2076
1576	=head3 Discussion	2077	=head3 Discussion
1577		2078
1578	This benchmark I<does> measure scalability and overall performance of the	2079	This benchmark I<does> measure scalability and overall performance of the
1579	particular event loop.	2080	particular event loop.
…		…
1581	EV is again fastest. Since it is using epoll on my system, the setup time	2082	EV is again fastest. Since it is using epoll on my system, the setup time
1582	is relatively high, though.	2083	is relatively high, though.
1583		2084
1584	Perl surprisingly comes second. It is much faster than the C-based event	2085	Perl surprisingly comes second. It is much faster than the C-based event
1585	loops Event and Glib.	2086	loops Event and Glib.
		2087
		2088	IO::Async performs very well when using its epoll backend, and still quite
		2089	good compared to Glib when using its pure perl backend.
1586		2090
1587	Event suffers from high setup time as well (look at its code and you will	2091	Event suffers from high setup time as well (look at its code and you will
1588	understand why). Callback invocation also has a high overhead compared to	2092	understand why). Callback invocation also has a high overhead compared to
1589	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2093	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1590	uses select or poll in basically all documented configurations.	2094	uses select or poll in basically all documented configurations.
…		…
1653	=item * C-based event loops perform very well with small number of	2157	=item * C-based event loops perform very well with small number of
1654	watchers, as the management overhead dominates.	2158	watchers, as the management overhead dominates.
1655		2159
1656	=back	2160	=back
1657		2161
		2162	=head2 THE IO::Lambda BENCHMARK
		2163
		2164	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2165	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2166	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2167	shouldn't come as a surprise to anybody). As such, the benchmark is
		2168	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2169	very optimal. But how would AnyEvent compare when used without the extra
		2170	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2171
		2172	The benchmark itself creates an echo-server, and then, for 500 times,
		2173	connects to the echo server, sends a line, waits for the reply, and then
		2174	creates the next connection. This is a rather bad benchmark, as it doesn't
		2175	test the efficiency of the framework or much non-blocking I/O, but it is a
		2176	benchmark nevertheless.
		2177
		2178	name runtime
		2179	Lambda/select 0.330 sec
		2180	+ optimized 0.122 sec
		2181	Lambda/AnyEvent 0.327 sec
		2182	+ optimized 0.138 sec
		2183	Raw sockets/select 0.077 sec
		2184	POE/select, components 0.662 sec
		2185	POE/select, raw sockets 0.226 sec
		2186	POE/select, optimized 0.404 sec
		2187
		2188	AnyEvent/select/nb 0.085 sec
		2189	AnyEvent/EV/nb 0.068 sec
		2190	+state machine 0.134 sec
		2191
		2192	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2193	benchmarks actually make blocking connects and use 100% blocking I/O,
		2194	defeating the purpose of an event-based solution. All of the newly
		2195	written AnyEvent benchmarks use 100% non-blocking connects (using
		2196	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2197	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2198	generally require a lot more bookkeeping and event handling than blocking
		2199	connects (which involve a single syscall only).
		2200
		2201	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2202	offers similar expressive power as POE and IO::Lambda, using conventional
		2203	Perl syntax. This means that both the echo server and the client are 100%
		2204	non-blocking, further placing it at a disadvantage.
		2205
		2206	As you can see, the AnyEvent + EV combination even beats the
		2207	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2208	backend easily beats IO::Lambda and POE.
		2209
		2210	And even the 100% non-blocking version written using the high-level (and
		2211	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
		2212	large margin, even though it does all of DNS, tcp-connect and socket I/O
		2213	in a non-blocking way.
		2214
		2215	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2216	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2217	part of the IO::lambda distribution and were used without any changes.
		2218
		2219
		2220	=head1 SIGNALS
		2221
		2222	AnyEvent currently installs handlers for these signals:
		2223
		2224	=over 4
		2225
		2226	=item SIGCHLD
		2227
		2228	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		2229	emulation for event loops that do not support them natively. Also, some
		2230	event loops install a similar handler.
		2231
		2232	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2233	AnyEvent will reset it to default, to avoid losing child exit statuses.
		2234
		2235	=item SIGPIPE
		2236
		2237	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		2238	when AnyEvent gets loaded.
		2239
		2240	The rationale for this is that AnyEvent users usually do not really depend
		2241	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		2242	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		2243	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		2244	some random socket.
		2245
		2246	The rationale for installing a no-op handler as opposed to ignoring it is
		2247	that this way, the handler will be restored to defaults on exec.
		2248
		2249	Feel free to install your own handler, or reset it to defaults.
		2250
		2251	=back
		2252
		2253	=cut
		2254
		2255	undef $SIG{CHLD}
		2256	if $SIG{CHLD} eq 'IGNORE';
		2257
		2258	$SIG{PIPE} = sub { }
		2259	unless defined $SIG{PIPE};
		2260
		2261	=head1 RECOMMENDED/OPTIONAL MODULES
		2262
		2263	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2264	it's built-in modules) are required to use it.
		2265
		2266	That does not mean that AnyEvent won't take advantage of some additional
		2267	modules if they are installed.
		2268
		2269	This section epxlains which additional modules will be used, and how they
		2270	affect AnyEvent's operetion.
		2271
		2272	=over 4
		2273
		2274	=item L<Async::Interrupt>
		2275
		2276	This slightly arcane module is used to implement fast signal handling: To
		2277	my knowledge, there is no way to do completely race-free and quick
		2278	signal handling in pure perl. To ensure that signals still get
		2279	delivered, AnyEvent will start an interval timer to wake up perl (and
		2280	catch the signals) with some delay (default is 10 seconds, look for
		2281	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2282
		2283	If this module is available, then it will be used to implement signal
		2284	catching, which means that signals will not be delayed, and the event loop
		2285	will not be interrupted regularly, which is more efficient (And good for
		2286	battery life on laptops).
		2287
		2288	This affects not just the pure-perl event loop, but also other event loops
		2289	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2290
		2291	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2292	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2293	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2294	does nothing for those backends.
		2295
		2296	=item L<EV>
		2297
		2298	This module isn't really "optional", as it is simply one of the backend
		2299	event loops that AnyEvent can use. However, it is simply the best event
		2300	loop available in terms of features, speed and stability: It supports
		2301	the AnyEvent API optimally, implements all the watcher types in XS, does
		2302	automatic timer adjustments even when no monotonic clock is available,
		2303	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2304	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2305	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2306
		2307	=item L<Guard>
		2308
		2309	The guard module, when used, will be used to implement
		2310	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2311	lot less memory), but otherwise doesn't affect guard operation much. It is
		2312	purely used for performance.
		2313
		2314	=item L<JSON> and L<JSON::XS>
		2315
		2316	This module is required when you want to read or write JSON data via
		2317	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2318	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.
		2319
		2320	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2321	installed.
		2322
		2323	=item L<Net::SSLeay>
		2324
		2325	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2326	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2327	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2328
		2329	=item L<Time::HiRes>
		2330
		2331	This module is part of perl since release 5.008. It will be used when the
		2332	chosen event library does not come with a timing source on it's own. The
		2333	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2334	try to use a monotonic clock for timing stability.
		2335
		2336	=back
		2337
1658		2338
1659	=head1 FORK	2339	=head1 FORK
1660		2340
1661	Most event libraries are not fork-safe. The ones who are usually are	2341	Most event libraries are not fork-safe. The ones who are usually are
1662	because they rely on inefficient but fork-safe C<select> or C<poll>	2342	because they rely on inefficient but fork-safe C<select> or C<poll>
1663	calls. Only L<EV> is fully fork-aware.	2343	calls. Only L<EV> is fully fork-aware.
1664		2344
1665	If you have to fork, you must either do so I<before> creating your first	2345	If you have to fork, you must either do so I<before> creating your first
1666	watcher OR you must not use AnyEvent at all in the child.	2346	watcher OR you must not use AnyEvent at all in the child OR you must do
		2347	something completely out of the scope of AnyEvent.
1667		2348
1668		2349
1669	=head1 SECURITY CONSIDERATIONS	2350	=head1 SECURITY CONSIDERATIONS
1670		2351
1671	AnyEvent can be forced to load any event model via	2352	AnyEvent can be forced to load any event model via
…		…
1682		2363
1683	use AnyEvent;	2364	use AnyEvent;
1684		2365
1685	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2366	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1686	be used to probe what backend is used and gain other information (which is	2367	be used to probe what backend is used and gain other information (which is
1687	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	2368	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		2369	$ENV{PERL_ANYEVENT_STRICT}.
		2370
		2371	Note that AnyEvent will remove I<all> environment variables starting with
		2372	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2373	enabled.
1688		2374
1689		2375
1690	=head1 BUGS	2376	=head1 BUGS
1691		2377
1692	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2378	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1693	to work around. If you suffer from memleaks, first upgrade to Perl 5.10	2379	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1694	and check wether the leaks still show up. (Perl 5.10.0 has other annoying	2380	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1695	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as	2381	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1696	pronounced).	2382	pronounced).
1697		2383
1698		2384
1699	=head1 SEE ALSO	2385	=head1 SEE ALSO
1700		2386
…		…
1704	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2390	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1705		2391
1706	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2392	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1707	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2393	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1708	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2394	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1709	L<AnyEvent::Impl::POE>.	2395	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
1710		2396
1711	Non-blocking file handles, sockets, TCP clients and	2397	Non-blocking file handles, sockets, TCP clients and
1712	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2398	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1713		2399
1714	Asynchronous DNS: L<AnyEvent::DNS>.	2400	Asynchronous DNS: L<AnyEvent::DNS>.
1715		2401
1716	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2402	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2403	L<Coro::Event>,
1717		2404
1718	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2405	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2406	L<AnyEvent::HTTP>.
1719		2407
1720		2408
1721	=head1 AUTHOR	2409	=head1 AUTHOR
1722		2410
1723	Marc Lehmann <schmorp@schmorp.de>	2411	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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