ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

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

Diff Legend

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