ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.198 by root, Thu Mar 26 20:17:44 2009 UTC vs.
Revision 1.261 by root, Tue Jul 28 12:56:17 2009 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
		6	and POE are various supported event loops/environments.
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 { ... });
12		14
		15	# one-shot or repeating timers
13	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
14	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
15		18
16	print AnyEvent->now; # prints current event loop time	19	print AnyEvent->now; # prints current event loop time
17	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
18		21
		22	# POSIX signal
19	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });	23	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
20		24
		25	# child process exit
21	my $w = AnyEvent->child (pid => $pid, cb => sub {	26	my $w = AnyEvent->child (pid => $pid, cb => sub {
22	my ($pid, $status) = @_;	27	my ($pid, $status) = @_;
23	...	28	...
24	});	29	});
		30
		31	# called when event loop idle (if applicable)
		32	my $w = AnyEvent->idle (cb => sub { ... });
25		33
26	my $w = AnyEvent->condvar; # stores whether a condition was flagged	34	my $w = AnyEvent->condvar; # stores whether a condition was flagged
27	$w->send; # wake up current and all future recv's	35	$w->send; # wake up current and all future recv's
28	$w->recv; # enters "main loop" till $condvar gets ->send	36	$w->recv; # enters "main loop" till $condvar gets ->send
29	# use a condvar in callback mode:	37	# use a condvar in callback mode:
…		…
32	=head1 INTRODUCTION/TUTORIAL	40	=head1 INTRODUCTION/TUTORIAL
33		41
34	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
35	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
36	L<AnyEvent::Intro> manpage.	44	L<AnyEvent::Intro> manpage.
		45
		46	=head1 SUPPORT
		47
		48	There is a mailinglist for discussing all things AnyEvent, and an IRC
		49	channel, too.
		50
		51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
37		53
38	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
39		55
40	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
41	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
168	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
169		185
170	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	186	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
171	with the following mandatory key-value pairs as arguments:	187	with the following mandatory key-value pairs as arguments:
172		188
173	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events	189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
174	(AnyEvent might or might not keep a reference to this file handle). C<poll>	190	for events (AnyEvent might or might not keep a reference to this file
		191	handle). Note that only file handles pointing to things for which
		192	non-blocking operation makes sense are allowed. This includes sockets,
		193	most character devices, pipes, fifos and so on, but not for example files
		194	or block devices.
		195
175	must be a string that is either C<r> or C<w>, which creates a watcher	196	C<poll> must be a string that is either C<r> or C<w>, which creates a
176	waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the	197	watcher waiting for "r"eadable or "w"ritable events, respectively.
		198
177	callback to invoke each time the file handle becomes ready.	199	C<cb> is the callback to invoke each time the file handle becomes ready.
178		200
179	Although the callback might get passed parameters, their value and	201	Although the callback might get passed parameters, their value and
180	presence is undefined and you cannot rely on them. Portable AnyEvent	202	presence is undefined and you cannot rely on them. Portable AnyEvent
181	callbacks cannot use arguments passed to I/O watcher callbacks.	203	callbacks cannot use arguments passed to I/O watcher callbacks.
182		204
…		…
314	In either case, if you care (and in most cases, you don't), then you	336	In either case, if you care (and in most cases, you don't), then you
315	can get whatever behaviour you want with any event loop, by taking the	337	can get whatever behaviour you want with any event loop, by taking the
316	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	338	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
317	account.	339	account.
318		340
		341	=item AnyEvent->now_update
		342
		343	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
		344	the current time for each loop iteration (see the discussion of L<<
		345	AnyEvent->now >>, above).
		346
		347	When a callback runs for a long time (or when the process sleeps), then
		348	this "current" time will differ substantially from the real time, which
		349	might affect timers and time-outs.
		350
		351	When this is the case, you can call this method, which will update the
		352	event loop's idea of "current time".
		353
		354	Note that updating the time I<might> cause some events to be handled.
		355
319	=back	356	=back
320		357
321	=head2 SIGNAL WATCHERS	358	=head2 SIGNAL WATCHERS
322		359
323	You can watch for signals using a signal watcher, C<signal> is the signal	360	You can watch for signals using a signal watcher, C<signal> is the signal
…		…
332	invocation, and callback invocation will be synchronous. Synchronous means	369	invocation, and callback invocation will be synchronous. Synchronous means
333	that it might take a while until the signal gets handled by the process,	370	that it might take a while until the signal gets handled by the process,
334	but it is guaranteed not to interrupt any other callbacks.	371	but it is guaranteed not to interrupt any other callbacks.
335		372
336	The main advantage of using these watchers is that you can share a signal	373	The main advantage of using these watchers is that you can share a signal
337	between multiple watchers.	374	between multiple watchers, and AnyEvent will ensure that signals will not
		375	interrupt your program at bad times.
338		376
339	This watcher might use C<%SIG>, so programs overwriting those signals	377	This watcher might use C<%SIG> (depending on the event loop used),
340	directly will likely not work correctly.	378	so programs overwriting those signals directly will likely not work
		379	correctly.
341		380
342	Example: exit on SIGINT	381	Example: exit on SIGINT
343		382
344	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
345		384
		385	=head3 Signal Races, Delays and Workarounds
		386
		387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		388	callbacks to signals in a generic way, which is a pity, as you cannot do
		389	race-free signal handling in perl. AnyEvent will try to do it's best, but
		390	in some cases, signals will be delayed. The maximum time a signal might
		391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
		392	seconds). This variable can be changed only before the first signal
		393	watcher is created, and should be left alone otherwise. Higher values
		394	will cause fewer spurious wake-ups, which is better for power and CPU
		395	saving. All these problems can be avoided by installing the optional
		396	L<Async::Interrupt> module. This will not work with inherently broken
		397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
		398	currently, as POE does it's own workaround with one-second latency). With
		399	those, you just have to suffer the delays.
		400
346	=head2 CHILD PROCESS WATCHERS	401	=head2 CHILD PROCESS WATCHERS
347		402
348	You can also watch on a child process exit and catch its exit status.	403	You can also watch on a child process exit and catch its exit status.
349		404
350	The child process is specified by the C<pid> argument (if set to C<0>, it	405	The child process is specified by the C<pid> argument (one some backends,
351	watches for any child process exit). The watcher will triggered only when	406	using C<0> watches for any child process exit, on others this will
352	the child process has finished and an exit status is available, not on	407	croak). The watcher will be triggered only when the child process has
353	any trace events (stopped/continued).	408	finished and an exit status is available, not on any trace events
		409	(stopped/continued).
354		410
355	The callback will be called with the pid and exit status (as returned by	411	The callback will be called with the pid and exit status (as returned by
356	waitpid), so unlike other watcher types, you I<can> rely on child watcher	412	waitpid), so unlike other watcher types, you I<can> rely on child watcher
357	callback arguments.	413	callback arguments.
358		414
…		…
363		419
364	There is a slight catch to child watchers, however: you usually start them	420	There is a slight catch to child watchers, however: you usually start them
365	I<after> the child process was created, and this means the process could	421	I<after> the child process was created, and this means the process could
366	have exited already (and no SIGCHLD will be sent anymore).	422	have exited already (and no SIGCHLD will be sent anymore).
367		423
368	Not all event models handle this correctly (POE doesn't), but even for	424	Not all event models handle this correctly (neither POE nor IO::Async do,
		425	see their AnyEvent::Impl manpages for details), but even for event models
369	event models that I<do> handle this correctly, they usually need to be	426	that I<do> handle this correctly, they usually need to be loaded before
370	loaded before the process exits (i.e. before you fork in the first place).	427	the process exits (i.e. before you fork in the first place). AnyEvent's
		428	pure perl event loop handles all cases correctly regardless of when you
		429	start the watcher.
371		430
372	This means you cannot create a child watcher as the very first thing in an	431	This means you cannot create a child watcher as the very first
373	AnyEvent program, you I<have> to create at least one watcher before you	432	thing in an AnyEvent program, you I<have> to create at least one
374	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	433	watcher before you C<fork> the child (alternatively, you can call
		434	C<AnyEvent::detect>).
		435
		436	As most event loops do not support waiting for child events, they will be
		437	emulated by AnyEvent in most cases, in which the latency and race problems
		438	mentioned in the description of signal watchers apply.
375		439
376	Example: fork a process and wait for it	440	Example: fork a process and wait for it
377		441
378	my $done = AnyEvent->condvar;	442	my $done = AnyEvent->condvar;
379		443
…		…
389	);	453	);
390		454
391	# do something else, then wait for process exit	455	# do something else, then wait for process exit
392	$done->recv;	456	$done->recv;
393		457
		458	=head2 IDLE WATCHERS
		459
		460	Sometimes there is a need to do something, but it is not so important
		461	to do it instantly, but only when there is nothing better to do. This
		462	"nothing better to do" is usually defined to be "no other events need
		463	attention by the event loop".
		464
		465	Idle watchers ideally get invoked when the event loop has nothing
		466	better to do, just before it would block the process to wait for new
		467	events. Instead of blocking, the idle watcher is invoked.
		468
		469	Most event loops unfortunately do not really support idle watchers (only
		470	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		471	will simply call the callback "from time to time".
		472
		473	Example: read lines from STDIN, but only process them when the
		474	program is otherwise idle:
		475
		476	my @lines; # read data
		477	my $idle_w;
		478	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		479	push @lines, scalar <STDIN>;
		480
		481	# start an idle watcher, if not already done
		482	$idle_w ||= AnyEvent->idle (cb => sub {
		483	# handle only one line, when there are lines left
		484	if (my $line = shift @lines) {
		485	print "handled when idle: $line";
		486	} else {
		487	# otherwise disable the idle watcher again
		488	undef $idle_w;
		489	}
		490	});
		491	});
		492
394	=head2 CONDITION VARIABLES	493	=head2 CONDITION VARIABLES
395		494
396	If you are familiar with some event loops you will know that all of them	495	If you are familiar with some event loops you will know that all of them
397	require you to run some blocking "loop", "run" or similar function that	496	require you to run some blocking "loop", "run" or similar function that
398	will actively watch for new events and call your callbacks.	497	will actively watch for new events and call your callbacks.
399		498
400	AnyEvent is different, it expects somebody else to run the event loop and	499	AnyEvent is slightly different: it expects somebody else to run the event
401	will only block when necessary (usually when told by the user).	500	loop and will only block when necessary (usually when told by the user).
402		501
403	The instrument to do that is called a "condition variable", so called	502	The instrument to do that is called a "condition variable", so called
404	because they represent a condition that must become true.	503	because they represent a condition that must become true.
405		504
		505	Now is probably a good time to look at the examples further below.
		506
406	Condition variables can be created by calling the C<< AnyEvent->condvar	507	Condition variables can be created by calling the C<< AnyEvent->condvar
407	>> method, usually without arguments. The only argument pair allowed is	508	>> method, usually without arguments. The only argument pair allowed is
408
409	C<cb>, which specifies a callback to be called when the condition variable	509	C<cb>, which specifies a callback to be called when the condition variable
410	becomes true, with the condition variable as the first argument (but not	510	becomes true, with the condition variable as the first argument (but not
411	the results).	511	the results).
412		512
413	After creation, the condition variable is "false" until it becomes "true"	513	After creation, the condition variable is "false" until it becomes "true"
…		…
418	Condition variables are similar to callbacks, except that you can	518	Condition variables are similar to callbacks, except that you can
419	optionally wait for them. They can also be called merge points - points	519	optionally wait for them. They can also be called merge points - points
420	in time where multiple outstanding events have been processed. And yet	520	in time where multiple outstanding events have been processed. And yet
421	another way to call them is transactions - each condition variable can be	521	another way to call them is transactions - each condition variable can be
422	used to represent a transaction, which finishes at some point and delivers	522	used to represent a transaction, which finishes at some point and delivers
423	a result.	523	a result. And yet some people know them as "futures" - a promise to
		524	compute/deliver something that you can wait for.
424		525
425	Condition variables are very useful to signal that something has finished,	526	Condition variables are very useful to signal that something has finished,
426	for example, if you write a module that does asynchronous http requests,	527	for example, if you write a module that does asynchronous http requests,
427	then a condition variable would be the ideal candidate to signal the	528	then a condition variable would be the ideal candidate to signal the
428	availability of results. The user can either act when the callback is	529	availability of results. The user can either act when the callback is
…		…
462	after => 1,	563	after => 1,
463	cb => sub { $result_ready->send },	564	cb => sub { $result_ready->send },
464	);	565	);
465		566
466	# this "blocks" (while handling events) till the callback	567	# this "blocks" (while handling events) till the callback
467	# calls send	568	# calls -<send
468	$result_ready->recv;	569	$result_ready->recv;
469		570
470	Example: wait for a timer, but take advantage of the fact that	571	Example: wait for a timer, but take advantage of the fact that condition
471	condition variables are also code references.	572	variables are also callable directly.
472		573
473	my $done = AnyEvent->condvar;	574	my $done = AnyEvent->condvar;
474	my $delay = AnyEvent->timer (after => 5, cb => $done);	575	my $delay = AnyEvent->timer (after => 5, cb => $done);
475	$done->recv;	576	$done->recv;
476		577
…		…
482		583
483	...	584	...
484		585
485	my @info = $couchdb->info->recv;	586	my @info = $couchdb->info->recv;
486		587
487	And this is how you would just ste a callback to be called whenever the	588	And this is how you would just set a callback to be called whenever the
488	results are available:	589	results are available:
489		590
490	$couchdb->info->cb (sub {	591	$couchdb->info->cb (sub {
491	my @info = $_[0]->recv;	592	my @info = $_[0]->recv;
492	});	593	});
…		…
510	immediately from within send.	611	immediately from within send.
511		612
512	Any arguments passed to the C<send> call will be returned by all	613	Any arguments passed to the C<send> call will be returned by all
513	future C<< ->recv >> calls.	614	future C<< ->recv >> calls.
514		615
515	Condition variables are overloaded so one can call them directly	616	Condition variables are overloaded so one can call them directly (as if
516	(as a code reference). Calling them directly is the same as calling	617	they were a code reference). Calling them directly is the same as calling
517	C<send>. Note, however, that many C-based event loops do not handle	618	C<send>.
518	overloading, so as tempting as it may be, passing a condition variable
519	instead of a callback does not work. Both the pure perl and EV loops
520	support overloading, however, as well as all functions that use perl to
521	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
522	example).
523		619
524	=item $cv->croak ($error)	620	=item $cv->croak ($error)
525		621
526	Similar to send, but causes all call's to C<< ->recv >> to invoke	622	Similar to send, but causes all call's to C<< ->recv >> to invoke
527	C<Carp::croak> with the given error message/object/scalar.	623	C<Carp::croak> with the given error message/object/scalar.
528		624
529	This can be used to signal any errors to the condition variable	625	This can be used to signal any errors to the condition variable
530	user/consumer.	626	user/consumer. Doing it this way instead of calling C<croak> directly
		627	delays the error detetcion, but has the overwhelmign advantage that it
		628	diagnoses the error at the place where the result is expected, and not
		629	deep in some event clalback without connection to the actual code causing
		630	the problem.
531		631
532	=item $cv->begin ([group callback])	632	=item $cv->begin ([group callback])
533		633
534	=item $cv->end	634	=item $cv->end
535
536	These two methods are EXPERIMENTAL and MIGHT CHANGE.
537		635
538	These two methods can be used to combine many transactions/events into	636	These two methods can be used to combine many transactions/events into
539	one. For example, a function that pings many hosts in parallel might want	637	one. For example, a function that pings many hosts in parallel might want
540	to use a condition variable for the whole process.	638	to use a condition variable for the whole process.
541		639
…		…
543	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	641	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
544	>>, the (last) callback passed to C<begin> will be executed. That callback	642	>>, the (last) callback passed to C<begin> will be executed. That callback
545	is I<supposed> to call C<< ->send >>, but that is not required. If no	643	is I<supposed> to call C<< ->send >>, but that is not required. If no
546	callback was set, C<send> will be called without any arguments.	644	callback was set, C<send> will be called without any arguments.
547		645
548	Let's clarify this with the ping example:	646	You can think of C<< $cv->send >> giving you an OR condition (one call
		647	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		648	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		649
		650	Let's start with a simple example: you have two I/O watchers (for example,
		651	STDOUT and STDERR for a program), and you want to wait for both streams to
		652	close before activating a condvar:
		653
		654	my $cv = AnyEvent->condvar;
		655
		656	$cv->begin; # first watcher
		657	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		658	defined sysread $fh1, my $buf, 4096
		659	or $cv->end;
		660	});
		661
		662	$cv->begin; # second watcher
		663	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		664	defined sysread $fh2, my $buf, 4096
		665	or $cv->end;
		666	});
		667
		668	$cv->recv;
		669
		670	This works because for every event source (EOF on file handle), there is
		671	one call to C<begin>, so the condvar waits for all calls to C<end> before
		672	sending.
		673
		674	The ping example mentioned above is slightly more complicated, as the
		675	there are results to be passwd back, and the number of tasks that are
		676	begung can potentially be zero:
549		677
550	my $cv = AnyEvent->condvar;	678	my $cv = AnyEvent->condvar;
551		679
552	my %result;	680	my %result;
553	$cv->begin (sub { $cv->send (\%result) });	681	$cv->begin (sub { $cv->send (\%result) });
…		…
573	loop, which serves two important purposes: first, it sets the callback	701	loop, which serves two important purposes: first, it sets the callback
574	to be called once the counter reaches C<0>, and second, it ensures that	702	to be called once the counter reaches C<0>, and second, it ensures that
575	C<send> is called even when C<no> hosts are being pinged (the loop	703	C<send> is called even when C<no> hosts are being pinged (the loop
576	doesn't execute once).	704	doesn't execute once).
577		705
578	This is the general pattern when you "fan out" into multiple subrequests:	706	This is the general pattern when you "fan out" into multiple (but
579	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	707	potentially none) subrequests: use an outer C<begin>/C<end> pair to set
580	is called at least once, and then, for each subrequest you start, call	708	the callback and ensure C<end> is called at least once, and then, for each
581	C<begin> and for each subrequest you finish, call C<end>.	709	subrequest you start, call C<begin> and for each subrequest you finish,
		710	call C<end>.
582		711
583	=back	712	=back
584		713
585	=head3 METHODS FOR CONSUMERS	714	=head3 METHODS FOR CONSUMERS
586		715
…		…
602	function will call C<croak>.	731	function will call C<croak>.
603		732
604	In list context, all parameters passed to C<send> will be returned,	733	In list context, all parameters passed to C<send> will be returned,
605	in scalar context only the first one will be returned.	734	in scalar context only the first one will be returned.
606		735
		736	Note that doing a blocking wait in a callback is not supported by any
		737	event loop, that is, recursive invocation of a blocking C<< ->recv
		738	>> is not allowed, and the C<recv> call will C<croak> if such a
		739	condition is detected. This condition can be slightly loosened by using
		740	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		741	any thread that doesn't run the event loop itself.
		742
607	Not all event models support a blocking wait - some die in that case	743	Not all event models support a blocking wait - some die in that case
608	(programs might want to do that to stay interactive), so I<if you are	744	(programs might want to do that to stay interactive), so I<if you are
609	using this from a module, never require a blocking wait>, but let the	745	using this from a module, never require a blocking wait>. Instead, let the
610	caller decide whether the call will block or not (for example, by coupling	746	caller decide whether the call will block or not (for example, by coupling
611	condition variables with some kind of request results and supporting	747	condition variables with some kind of request results and supporting
612	callbacks so the caller knows that getting the result will not block,	748	callbacks so the caller knows that getting the result will not block,
613	while still supporting blocking waits if the caller so desires).	749	while still supporting blocking waits if the caller so desires).
614		750
615	Another reason I<never> to C<< ->recv >> in a module is that you cannot
616	sensibly have two C<< ->recv >>'s in parallel, as that would require
617	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
618	can supply.
619
620	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
621	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
622	versions and also integrates coroutines into AnyEvent, making blocking
623	C<< ->recv >> calls perfectly safe as long as they are done from another
624	coroutine (one that doesn't run the event loop).
625
626	You can ensure that C<< -recv >> never blocks by setting a callback and	751	You can ensure that C<< -recv >> never blocks by setting a callback and
627	only calling C<< ->recv >> from within that callback (or at a later	752	only calling C<< ->recv >> from within that callback (or at a later
628	time). This will work even when the event loop does not support blocking	753	time). This will work even when the event loop does not support blocking
629	waits otherwise.	754	waits otherwise.
630		755
…		…
643	variable itself. Calling C<recv> inside the callback or at any later time	768	variable itself. Calling C<recv> inside the callback or at any later time
644	is guaranteed not to block.	769	is guaranteed not to block.
645		770
646	=back	771	=back
647		772
		773	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		774
		775	The available backend classes are (every class has its own manpage):
		776
		777	=over 4
		778
		779	=item Backends that are autoprobed when no other event loop can be found.
		780
		781	EV is the preferred backend when no other event loop seems to be in
		782	use. If EV is not installed, then AnyEvent will try Event, and, failing
		783	that, will fall back to its own pure-perl implementation, which is
		784	available everywhere as it comes with AnyEvent itself.
		785
		786	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		787	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		788	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		789
		790	=item Backends that are transparently being picked up when they are used.
		791
		792	These will be used when they are currently loaded when the first watcher
		793	is created, in which case it is assumed that the application is using
		794	them. This means that AnyEvent will automatically pick the right backend
		795	when the main program loads an event module before anything starts to
		796	create watchers. Nothing special needs to be done by the main program.
		797
		798	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		799	AnyEvent::Impl::Tk based on Tk, very broken.
		800	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		801	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		802	AnyEvent::Impl::Irssi used when running within irssi.
		803
		804	=item Backends with special needs.
		805
		806	Qt requires the Qt::Application to be instantiated first, but will
		807	otherwise be picked up automatically. As long as the main program
		808	instantiates the application before any AnyEvent watchers are created,
		809	everything should just work.
		810
		811	AnyEvent::Impl::Qt based on Qt.
		812
		813	Support for IO::Async can only be partial, as it is too broken and
		814	architecturally limited to even support the AnyEvent API. It also
		815	is the only event loop that needs the loop to be set explicitly, so
		816	it can only be used by a main program knowing about AnyEvent. See
		817	L<AnyEvent::Impl::Async> for the gory details.
		818
		819	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		820
		821	=item Event loops that are indirectly supported via other backends.
		822
		823	Some event loops can be supported via other modules:
		824
		825	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		826
		827	B<WxWidgets> has no support for watching file handles. However, you can
		828	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		829	polls 20 times per second, which was considered to be too horrible to even
		830	consider for AnyEvent.
		831
		832	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		833	backend, so it can be supported through POE.
		834
		835	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		836	load L<POE> when detecting them, in the hope that POE will pick them up,
		837	in which case everything will be automatic.
		838
		839	=back
		840
648	=head1 GLOBAL VARIABLES AND FUNCTIONS	841	=head1 GLOBAL VARIABLES AND FUNCTIONS
649		842
		843	These are not normally required to use AnyEvent, but can be useful to
		844	write AnyEvent extension modules.
		845
650	=over 4	846	=over 4
651		847
652	=item $AnyEvent::MODEL	848	=item $AnyEvent::MODEL
653		849
654	Contains C<undef> until the first watcher is being created. Then it	850	Contains C<undef> until the first watcher is being created, before the
		851	backend has been autodetected.
		852
655	contains the event model that is being used, which is the name of the	853	Afterwards it contains the event model that is being used, which is the
656	Perl class implementing the model. This class is usually one of the	854	name of the Perl class implementing the model. This class is usually one
657	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	855	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
658	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	856	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
659		857	will be C<urxvt::anyevent>).
660	The known classes so far are:
661
662	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
663	AnyEvent::Impl::Event based on Event, second best choice.
664	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
665	AnyEvent::Impl::Glib based on Glib, third-best choice.
666	AnyEvent::Impl::Tk based on Tk, very bad choice.
667	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
668	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
669	AnyEvent::Impl::POE based on POE, not generic enough for full support.
670
671	There is no support for WxWidgets, as WxWidgets has no support for
672	watching file handles. However, you can use WxWidgets through the
673	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
674	second, which was considered to be too horrible to even consider for
675	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
676	it's adaptor.
677
678	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
679	autodetecting them.
680		858
681	=item AnyEvent::detect	859	=item AnyEvent::detect
682		860
683	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	861	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
684	if necessary. You should only call this function right before you would	862	if necessary. You should only call this function right before you would
685	have created an AnyEvent watcher anyway, that is, as late as possible at	863	have created an AnyEvent watcher anyway, that is, as late as possible at
686	runtime.	864	runtime, and not e.g. while initialising of your module.
		865
		866	If you need to do some initialisation before AnyEvent watchers are
		867	created, use C<post_detect>.
687		868
688	=item $guard = AnyEvent::post_detect { BLOCK }	869	=item $guard = AnyEvent::post_detect { BLOCK }
689		870
690	Arranges for the code block to be executed as soon as the event model is	871	Arranges for the code block to be executed as soon as the event model is
691	autodetected (or immediately if this has already happened).	872	autodetected (or immediately if this has already happened).
692		873
		874	The block will be executed I<after> the actual backend has been detected
		875	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		876	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		877	other initialisations - see the sources of L<AnyEvent::Strict> or
		878	L<AnyEvent::AIO> to see how this is used.
		879
		880	The most common usage is to create some global watchers, without forcing
		881	event module detection too early, for example, L<AnyEvent::AIO> creates
		882	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		883	avoid autodetecting the event module at load time.
		884
693	If called in scalar or list context, then it creates and returns an object	885	If called in scalar or list context, then it creates and returns an object
694	that automatically removes the callback again when it is destroyed. See	886	that automatically removes the callback again when it is destroyed (or
		887	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
695	L<Coro::BDB> for a case where this is useful.	888	a case where this is useful.
		889
		890	Example: Create a watcher for the IO::AIO module and store it in
		891	C<$WATCHER>. Only do so after the event loop is initialised, though.
		892
		893	our WATCHER;
		894
		895	my $guard = AnyEvent::post_detect {
		896	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		897	};
		898
		899	# the ||= is important in case post_detect immediately runs the block,
		900	# as to not clobber the newly-created watcher. assigning both watcher and
		901	# post_detect guard to the same variable has the advantage of users being
		902	# able to just C<undef $WATCHER> if the watcher causes them grief.
		903
		904	$WATCHER ||= $guard;
696		905
697	=item @AnyEvent::post_detect	906	=item @AnyEvent::post_detect
698		907
699	If there are any code references in this array (you can C<push> to it	908	If there are any code references in this array (you can C<push> to it
700	before or after loading AnyEvent), then they will called directly after	909	before or after loading AnyEvent), then they will called directly after
701	the event loop has been chosen.	910	the event loop has been chosen.
702		911
703	You should check C<$AnyEvent::MODEL> before adding to this array, though:	912	You should check C<$AnyEvent::MODEL> before adding to this array, though:
704	if it contains a true value then the event loop has already been detected,	913	if it is defined then the event loop has already been detected, and the
705	and the array will be ignored.	914	array will be ignored.
706		915
707	Best use C<AnyEvent::post_detect { BLOCK }> instead.	916	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		917	it,as it takes care of these details.
		918
		919	This variable is mainly useful for modules that can do something useful
		920	when AnyEvent is used and thus want to know when it is initialised, but do
		921	not need to even load it by default. This array provides the means to hook
		922	into AnyEvent passively, without loading it.
708		923
709	=back	924	=back
710		925
711	=head1 WHAT TO DO IN A MODULE	926	=head1 WHAT TO DO IN A MODULE
712		927
…		…
767		982
768		983
769	=head1 OTHER MODULES	984	=head1 OTHER MODULES
770		985
771	The following is a non-exhaustive list of additional modules that use	986	The following is a non-exhaustive list of additional modules that use
772	AnyEvent and can therefore be mixed easily with other AnyEvent modules	987	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
773	in the same program. Some of the modules come with AnyEvent, some are	988	modules and other event loops in the same program. Some of the modules
774	available via CPAN.	989	come with AnyEvent, most are available via CPAN.
775		990
776	=over 4	991	=over 4
777		992
778	=item L<AnyEvent::Util>	993	=item L<AnyEvent::Util>
779		994
…		…
788		1003
789	=item L<AnyEvent::Handle>	1004	=item L<AnyEvent::Handle>
790		1005
791	Provide read and write buffers, manages watchers for reads and writes,	1006	Provide read and write buffers, manages watchers for reads and writes,
792	supports raw and formatted I/O, I/O queued and fully transparent and	1007	supports raw and formatted I/O, I/O queued and fully transparent and
793	non-blocking SSL/TLS.	1008	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
794		1009
795	=item L<AnyEvent::DNS>	1010	=item L<AnyEvent::DNS>
796		1011
797	Provides rich asynchronous DNS resolver capabilities.	1012	Provides rich asynchronous DNS resolver capabilities.
798		1013
…		…
826		1041
827	=item L<AnyEvent::GPSD>	1042	=item L<AnyEvent::GPSD>
828		1043
829	A non-blocking interface to gpsd, a daemon delivering GPS information.	1044	A non-blocking interface to gpsd, a daemon delivering GPS information.
830		1045
		1046	=item L<AnyEvent::IRC>
		1047
		1048	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1049
		1050	=item L<AnyEvent::XMPP>
		1051
		1052	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1053	Net::XMPP2>.
		1054
831	=item L<AnyEvent::IGS>	1055	=item L<AnyEvent::IGS>
832		1056
833	A non-blocking interface to the Internet Go Server protocol (used by	1057	A non-blocking interface to the Internet Go Server protocol (used by
834	L<App::IGS>).	1058	L<App::IGS>).
835		1059
836	=item L<AnyEvent::IRC>
837
838	AnyEvent based IRC client module family (replacing the older Net::IRC3).
839
840	=item L<Net::XMPP2>
841
842	AnyEvent based XMPP (Jabber protocol) module family.
843
844	=item L<Net::FCP>	1060	=item L<Net::FCP>
845		1061
846	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1062	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
847	of AnyEvent.	1063	of AnyEvent.
848		1064
…		…
852		1068
853	=item L<Coro>	1069	=item L<Coro>
854		1070
855	Has special support for AnyEvent via L<Coro::AnyEvent>.	1071	Has special support for AnyEvent via L<Coro::AnyEvent>.
856		1072
857	=item L<IO::Lambda>
858
859	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
860
861	=back	1073	=back
862		1074
863	=cut	1075	=cut
864		1076
865	package AnyEvent;	1077	package AnyEvent;
866		1078
		1079	# basically a tuned-down version of common::sense
		1080	sub common_sense {
867	no warnings;	1081	# no warnings
		1082	${^WARNING_BITS} ^= ${^WARNING_BITS};
868	use strict qw(vars subs);	1083	# use strict vars subs
		1084	$^H |= 0x00000600;
		1085	}
869		1086
		1087	BEGIN { AnyEvent::common_sense }
		1088
870	use Carp;	1089	use Carp ();
871		1090
872	our $VERSION = 4.341;	1091	our $VERSION = 4.881;
873	our $MODEL;	1092	our $MODEL;
874		1093
875	our $AUTOLOAD;	1094	our $AUTOLOAD;
876	our @ISA;	1095	our @ISA;
877		1096
878	our @REGISTRY;	1097	our @REGISTRY;
879		1098
880	our $WIN32;	1099	our $WIN32;
881		1100
		1101	our $VERBOSE;
		1102
882	BEGIN {	1103	BEGIN {
883	my $win32 = ! ! ($^O =~ /mswin32/i);	1104	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
884	eval "sub WIN32(){ $win32 }";	1105	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
885	}
886		1106
		1107	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1108	if ${^TAINT};
		1109
887	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1110	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1111
		1112	}
		1113
		1114	our $MAX_SIGNAL_LATENCY = 10;
888		1115
889	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1116	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
890		1117
891	{	1118	{
892	my $idx;	1119	my $idx;
…		…
894	for reverse split /\s*,\s*/,	1121	for reverse split /\s*,\s*/,
895	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1122	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
896	}	1123	}
897		1124
898	my @models = (	1125	my @models = (
899	[EV:: => AnyEvent::Impl::EV::],	1126	[EV:: => AnyEvent::Impl::EV:: , 1],
900	[Event:: => AnyEvent::Impl::Event::],	1127	[Event:: => AnyEvent::Impl::Event::, 1],
901	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1128	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
902	# everything below here will not be autoprobed	1129	# everything below here will not (normally) be autoprobed
903	# as the pureperl backend should work everywhere	1130	# as the pureperl backend should work everywhere
904	# and is usually faster	1131	# and is usually faster
		1132	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1133	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1134	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
905	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1135	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
906	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
907	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
908	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1136	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
909	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1137	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
910	[Wx:: => AnyEvent::Impl::POE::],	1138	[Wx:: => AnyEvent::Impl::POE::],
911	[Prima:: => AnyEvent::Impl::POE::],	1139	[Prima:: => AnyEvent::Impl::POE::],
		1140	# IO::Async is just too broken - we would need workarounds for its
		1141	# byzantine signal and broken child handling, among others.
		1142	# IO::Async is rather hard to detect, as it doesn't have any
		1143	# obvious default class.
		1144	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1145	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1146	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
912	);	1147	);
913		1148
914	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1149	our %method = map +($_ => 1),
		1150	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
915		1151
916	our @post_detect;	1152	our @post_detect;
917		1153
918	sub post_detect(&) {	1154	sub post_detect(&) {
919	my ($cb) = @_;	1155	my ($cb) = @_;
920		1156
921	if ($MODEL) {	1157	if ($MODEL) {
922	$cb->();	1158	$cb->();
923		1159
924	1	1160	undef
925	} else {	1161	} else {
926	push @post_detect, $cb;	1162	push @post_detect, $cb;
927		1163
928	defined wantarray	1164	defined wantarray
929	? bless \$cb, "AnyEvent::Util::PostDetect"	1165	? bless \$cb, "AnyEvent::Util::postdetect"
930	: ()	1166	: ()
931	}	1167	}
932	}	1168	}
933		1169
934	sub AnyEvent::Util::PostDetect::DESTROY {	1170	sub AnyEvent::Util::postdetect::DESTROY {
935	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1171	@post_detect = grep $_ != ${$_[0]}, @post_detect;
936	}	1172	}
937		1173
938	sub detect() {	1174	sub detect() {
939	unless ($MODEL) {	1175	unless ($MODEL) {
940	no strict 'refs';
941	local $SIG{__DIE__};	1176	local $SIG{__DIE__};
942		1177
943	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1178	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
944	my $model = "AnyEvent::Impl::$1";	1179	my $model = "AnyEvent::Impl::$1";
945	if (eval "require $model") {	1180	if (eval "require $model") {
946	$MODEL = $model;	1181	$MODEL = $model;
947	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1182	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
948	} else {	1183	} else {
949	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1184	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
950	}	1185	}
951	}	1186	}
952		1187
953	# check for already loaded models	1188	# check for already loaded models
954	unless ($MODEL) {	1189	unless ($MODEL) {
955	for (@REGISTRY, @models) {	1190	for (@REGISTRY, @models) {
956	my ($package, $model) = @$_;	1191	my ($package, $model) = @$_;
957	if (${"$package\::VERSION"} > 0) {	1192	if (${"$package\::VERSION"} > 0) {
958	if (eval "require $model") {	1193	if (eval "require $model") {
959	$MODEL = $model;	1194	$MODEL = $model;
960	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1195	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
961	last;	1196	last;
962	}	1197	}
963	}	1198	}
964	}	1199	}
965		1200
966	unless ($MODEL) {	1201	unless ($MODEL) {
967	# try to load a model	1202	# try to autoload a model
968
969	for (@REGISTRY, @models) {	1203	for (@REGISTRY, @models) {
970	my ($package, $model) = @$_;	1204	my ($package, $model, $autoload) = @$_;
		1205	if (
		1206	$autoload
971	if (eval "require $package"	1207	and eval "require $package"
972	and ${"$package\::VERSION"} > 0	1208	and ${"$package\::VERSION"} > 0
973	and eval "require $model") {	1209	and eval "require $model"
		1210	) {
974	$MODEL = $model;	1211	$MODEL = $model;
975	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1212	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
976	last;	1213	last;
977	}	1214	}
978	}	1215	}
979		1216
980	$MODEL	1217	$MODEL
981	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1218	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
982	}	1219	}
983	}	1220	}
984		1221
985	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1222	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986		1223
…		…
996		1233
997	sub AUTOLOAD {	1234	sub AUTOLOAD {
998	(my $func = $AUTOLOAD) =~ s/.*://;	1235	(my $func = $AUTOLOAD) =~ s/.*://;
999		1236
1000	$method{$func}	1237	$method{$func}
1001	or croak "$func: not a valid method for AnyEvent objects";	1238	or Carp::croak "$func: not a valid method for AnyEvent objects";
1002		1239
1003	detect unless $MODEL;	1240	detect unless $MODEL;
1004		1241
1005	my $class = shift;	1242	my $class = shift;
1006	$class->$func (@_);	1243	$class->$func (@_);
1007	}	1244	}
1008		1245
1009	# utility function to dup a filehandle. this is used by many backends	1246	# utility function to dup a filehandle. this is used by many backends
1010	# to support binding more than one watcher per filehandle (they usually	1247	# to support binding more than one watcher per filehandle (they usually
1011	# allow only one watcher per fd, so we dup it to get a different one).	1248	# allow only one watcher per fd, so we dup it to get a different one).
1012	sub _dupfh($$$$) {	1249	sub _dupfh($$;$$) {
1013	my ($poll, $fh, $r, $w) = @_;	1250	my ($poll, $fh, $r, $w) = @_;
1014		1251
1015	# cygwin requires the fh mode to be matching, unix doesn't	1252	# cygwin requires the fh mode to be matching, unix doesn't
1016	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1253	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1017	: $poll eq "w" ? ($w, ">")
1018	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1019		1254
1020	open my $fh2, "$mode&" . fileno $fh	1255	open my $fh2, $mode, $fh
1021	or die "cannot dup() filehandle: $!";	1256	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1022		1257
1023	# we assume CLOEXEC is already set by perl in all important cases	1258	# we assume CLOEXEC is already set by perl in all important cases
1024		1259
1025	($fh2, $rw)	1260	($fh2, $rw)
1026	}	1261	}
1027		1262
1028	package AnyEvent::Base;	1263	package AnyEvent::Base;
1029		1264
1030	# default implementation for now and time	1265	# default implementations for many methods
1031		1266
1032	BEGIN {	1267	sub _time {
		1268	# probe for availability of Time::HiRes
1033	if (eval "use Time::HiRes (); time (); 1") {	1269	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1270	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1034	*_time = \&Time::HiRes::time;	1271	*_time = \&Time::HiRes::time;
1035	# if (eval "use POSIX (); (POSIX::times())...	1272	# if (eval "use POSIX (); (POSIX::times())...
1036	} else {	1273	} else {
		1274	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1037	*_time = sub { time }; # epic fail	1275	*_time = sub { time }; # epic fail
1038	}	1276	}
		1277
		1278	&_time
1039	}	1279	}
1040		1280
1041	sub time { _time }	1281	sub time { _time }
1042	sub now { _time }	1282	sub now { _time }
		1283	sub now_update { }
1043		1284
1044	# default implementation for ->condvar	1285	# default implementation for ->condvar
1045		1286
1046	sub condvar {	1287	sub condvar {
1047	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1288	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1048	}	1289	}
1049		1290
1050	# default implementation for ->signal	1291	# default implementation for ->signal
1051		1292
		1293	our $HAVE_ASYNC_INTERRUPT;
1052	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1294	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1295	our (%SIG_ASY, %SIG_ASY_W);
		1296	our ($SIG_COUNT, $SIG_TW);
1053		1297
1054	sub _signal_exec {	1298	sub _signal_exec {
		1299	$HAVE_ASYNC_INTERRUPT
		1300	? $SIGPIPE_R->drain
1055	sysread $SIGPIPE_R, my $dummy, 4;	1301	: sysread $SIGPIPE_R, my $dummy, 9;
1056		1302
1057	while (%SIG_EV) {	1303	while (%SIG_EV) {
1058	for (keys %SIG_EV) {	1304	for (keys %SIG_EV) {
1059	delete $SIG_EV{$_};	1305	delete $SIG_EV{$_};
1060	$_->() for values %{ $SIG_CB{$_} || {} };	1306	$_->() for values %{ $SIG_CB{$_} || {} };
1061	}	1307	}
1062	}	1308	}
1063	}	1309	}
1064		1310
		1311	# install a dummy wakeup watcher to reduce signal catching latency
		1312	sub _sig_add() {
		1313	unless ($SIG_COUNT++) {
		1314	# try to align timer on a full-second boundary, if possible
		1315	my $NOW = AnyEvent->now;
		1316
		1317	$SIG_TW = AnyEvent->timer (
		1318	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1319	interval => $MAX_SIGNAL_LATENCY,
		1320	cb => sub { }, # just for the PERL_ASYNC_CHECK
		1321	);
		1322	}
		1323	}
		1324
		1325	sub _sig_del {
		1326	undef $SIG_TW
		1327	unless --$SIG_COUNT;
		1328	}
		1329
		1330	sub _signal {
		1331	my (undef, %arg) = @_;
		1332
		1333	my $signal = uc $arg{signal}
		1334	or Carp::croak "required option 'signal' is missing";
		1335
		1336	if ($HAVE_ASYNC_INTERRUPT) {
		1337	# async::interrupt
		1338
		1339	$signal = Async::Interrupt::sig2num ($signal);
		1340	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1341
		1342	$SIG_ASY{$signal} ||= do {
		1343	my $asy = new Async::Interrupt
		1344	cb => sub { undef $SIG_EV{$signal} },
		1345	signal => $signal,
		1346	pipe => [$SIGPIPE_R->filenos],
		1347	;
		1348	$asy->pipe_autodrain (0);
		1349
		1350	$asy
		1351	};
		1352
		1353	} else {
		1354	# pure perl
		1355
		1356	# AE::Util has been loaded in signal
		1357	$signal = AnyEvent::Util::sig2name ($signal);
		1358	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1359
		1360	$SIG{$signal} ||= sub {
		1361	local $!;
		1362	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1363	undef $SIG_EV{$signal};
		1364	};
		1365
		1366	# can't do signal processing without introducing races in pure perl,
		1367	# so limit the signal latency.
		1368	_sig_add;
		1369	}
		1370
		1371	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1372	}
		1373
1065	sub signal {	1374	sub signal {
1066	my (undef, %arg) = @_;	1375	# probe for availability of Async::Interrupt
		1376	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 1.0 (); 1") {
		1377	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1067		1378
1068	unless ($SIGPIPE_R) {	1379	$HAVE_ASYNC_INTERRUPT = 1;
		1380	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1381	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
		1382
		1383	} else {
		1384	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1385
		1386	require Fcntl;
		1387
1069	if (AnyEvent::WIN32) {	1388	if (AnyEvent::WIN32) {
		1389	require AnyEvent::Util;
		1390
1070	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1391	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1071	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;	1392	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1072	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case	1393	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1073	} else {	1394	} else {
1074	pipe $SIGPIPE_R, $SIGPIPE_W;	1395	pipe $SIGPIPE_R, $SIGPIPE_W;
1075	require Fcntl;
1076	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1396	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1077	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1397	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1398
		1399	# not strictly required, as $^F is normally 2, but let's make sure...
		1400	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1401	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1078	}	1402	}
1079		1403
1080	$SIGPIPE_R	1404	$SIGPIPE_R
1081	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1405	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1082		1406
1083	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1407	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1084	}	1408	}
1085		1409
1086	my $signal = uc $arg{signal}	1410	*signal = \&_signal;
1087	or Carp::croak "required option 'signal' is missing";	1411	&signal
1088
1089	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1090	$SIG{$signal} ||= sub {
1091	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1092	undef $SIG_EV{$signal};
1093	};
1094
1095	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
1096	}	1412	}
1097		1413
1098	sub AnyEvent::Base::Signal::DESTROY {	1414	sub AnyEvent::Base::signal::DESTROY {
1099	my ($signal, $cb) = @{$_[0]};	1415	my ($signal, $cb) = @{$_[0]};
1100		1416
		1417	_sig_del;
		1418
1101	delete $SIG_CB{$signal}{$cb};	1419	delete $SIG_CB{$signal}{$cb};
1102		1420
		1421	$HAVE_ASYNC_INTERRUPT
		1422	? delete $SIG_ASY{$signal}
		1423	: # delete doesn't work with older perls - they then
		1424	# print weird messages, or just unconditionally exit
		1425	# instead of getting the default action.
		1426	undef $SIG{$signal}
1103	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };	1427	unless keys %{ $SIG_CB{$signal} };
1104	}	1428	}
1105		1429
1106	# default implementation for ->child	1430	# default implementation for ->child
1107		1431
1108	our %PID_CB;	1432	our %PID_CB;
1109	our $CHLD_W;	1433	our $CHLD_W;
1110	our $CHLD_DELAY_W;	1434	our $CHLD_DELAY_W;
1111	our $PID_IDLE;
1112	our $WNOHANG;	1435	our $WNOHANG;
1113		1436
1114	sub _child_wait {	1437	sub _emit_childstatus($$) {
1115	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1438	my (undef, $rpid, $rstatus) = @_;
		1439
		1440	$_->($rpid, $rstatus)
1116	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1441	for values %{ $PID_CB{$rpid} || {} },
1117	(values %{ $PID_CB{0} || {} });	1442	values %{ $PID_CB{0} || {} };
1118	}
1119
1120	undef $PID_IDLE;
1121	}	1443	}
1122		1444
1123	sub _sigchld {	1445	sub _sigchld {
1124	# make sure we deliver these changes "synchronous" with the event loop.	1446	my $pid;
1125	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {	1447
1126	undef $CHLD_DELAY_W;	1448	AnyEvent->_emit_childstatus ($pid, $?)
1127	&_child_wait;	1449	while ($pid = waitpid -1, $WNOHANG) > 0;
1128	});
1129	}	1450	}
1130		1451
1131	sub child {	1452	sub child {
1132	my (undef, %arg) = @_;	1453	my (undef, %arg) = @_;
1133		1454
1134	defined (my $pid = $arg{pid} + 0)	1455	defined (my $pid = $arg{pid} + 0)
1135	or Carp::croak "required option 'pid' is missing";	1456	or Carp::croak "required option 'pid' is missing";
1136		1457
1137	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1458	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1138		1459
1139	unless ($WNOHANG) {	1460	# WNOHANG is almost cetrainly 1 everywhere
		1461	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
		1462	? 1
1140	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1463	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1141	}
1142		1464
1143	unless ($CHLD_W) {	1465	unless ($CHLD_W) {
1144	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1466	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1145	# child could be a zombie already, so make at least one round	1467	# child could be a zombie already, so make at least one round
1146	&_sigchld;	1468	&_sigchld;
1147	}	1469	}
1148		1470
1149	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1471	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1150	}	1472	}
1151		1473
1152	sub AnyEvent::Base::Child::DESTROY {	1474	sub AnyEvent::Base::child::DESTROY {
1153	my ($pid, $cb) = @{$_[0]};	1475	my ($pid, $cb) = @{$_[0]};
1154		1476
1155	delete $PID_CB{$pid}{$cb};	1477	delete $PID_CB{$pid}{$cb};
1156	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1478	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1157		1479
1158	undef $CHLD_W unless keys %PID_CB;	1480	undef $CHLD_W unless keys %PID_CB;
1159	}	1481	}
1160		1482
		1483	# idle emulation is done by simply using a timer, regardless
		1484	# of whether the process is idle or not, and not letting
		1485	# the callback use more than 50% of the time.
		1486	sub idle {
		1487	my (undef, %arg) = @_;
		1488
		1489	my ($cb, $w, $rcb) = $arg{cb};
		1490
		1491	$rcb = sub {
		1492	if ($cb) {
		1493	$w = _time;
		1494	&$cb;
		1495	$w = _time - $w;
		1496
		1497	# never use more then 50% of the time for the idle watcher,
		1498	# within some limits
		1499	$w = 0.0001 if $w < 0.0001;
		1500	$w = 5 if $w > 5;
		1501
		1502	$w = AnyEvent->timer (after => $w, cb => $rcb);
		1503	} else {
		1504	# clean up...
		1505	undef $w;
		1506	undef $rcb;
		1507	}
		1508	};
		1509
		1510	$w = AnyEvent->timer (after => 0.05, cb => $rcb);
		1511
		1512	bless \\$cb, "AnyEvent::Base::idle"
		1513	}
		1514
		1515	sub AnyEvent::Base::idle::DESTROY {
		1516	undef $${$_[0]};
		1517	}
		1518
1161	package AnyEvent::CondVar;	1519	package AnyEvent::CondVar;
1162		1520
1163	our @ISA = AnyEvent::CondVar::Base::;	1521	our @ISA = AnyEvent::CondVar::Base::;
1164		1522
1165	package AnyEvent::CondVar::Base;	1523	package AnyEvent::CondVar::Base;
1166		1524
1167	use overload	1525	#use overload
1168	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1526	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1169	fallback => 1;	1527	# fallback => 1;
		1528
		1529	# save 300+ kilobytes by dirtily hardcoding overloading
		1530	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1531	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1532	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1533	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1534
		1535	our $WAITING;
1170		1536
1171	sub _send {	1537	sub _send {
1172	# nop	1538	# nop
1173	}	1539	}
1174		1540
…		…
1187	sub ready {	1553	sub ready {
1188	$_[0]{_ae_sent}	1554	$_[0]{_ae_sent}
1189	}	1555	}
1190		1556
1191	sub _wait {	1557	sub _wait {
		1558	$WAITING
		1559	and !$_[0]{_ae_sent}
		1560	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1561
		1562	local $WAITING = 1;
1192	AnyEvent->one_event while !$_[0]{_ae_sent};	1563	AnyEvent->one_event while !$_[0]{_ae_sent};
1193	}	1564	}
1194		1565
1195	sub recv {	1566	sub recv {
1196	$_[0]->_wait;	1567	$_[0]->_wait;
…		…
1237	so on.	1608	so on.
1238		1609
1239	=head1 ENVIRONMENT VARIABLES	1610	=head1 ENVIRONMENT VARIABLES
1240		1611
1241	The following environment variables are used by this module or its	1612	The following environment variables are used by this module or its
1242	submodules:	1613	submodules.
		1614
		1615	Note that AnyEvent will remove I<all> environment variables starting with
		1616	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1617	enabled.
1243		1618
1244	=over 4	1619	=over 4
1245		1620
1246	=item C<PERL_ANYEVENT_VERBOSE>	1621	=item C<PERL_ANYEVENT_VERBOSE>
1247		1622
…		…
1254	C<PERL_ANYEVENT_MODEL>.	1629	C<PERL_ANYEVENT_MODEL>.
1255		1630
1256	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1631	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1257	model it chooses.	1632	model it chooses.
1258		1633
		1634	When set to C<8> or higher, then AnyEvent will report extra information on
		1635	which optional modules it loads and how it implements certain features.
		1636
1259	=item C<PERL_ANYEVENT_STRICT>	1637	=item C<PERL_ANYEVENT_STRICT>
1260		1638
1261	AnyEvent does not do much argument checking by default, as thorough	1639	AnyEvent does not do much argument checking by default, as thorough
1262	argument checking is very costly. Setting this variable to a true value	1640	argument checking is very costly. Setting this variable to a true value
1263	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1641	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1264	check the arguments passed to most method calls. If it finds any problems	1642	check the arguments passed to most method calls. If it finds any problems,
1265	it will croak.	1643	it will croak.
1266		1644
1267	In other words, enables "strict" mode.	1645	In other words, enables "strict" mode.
1268		1646
1269	Unlike C<use strict>, it is definitely recommended ot keep it off in	1647	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1270	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1648	>>, it is definitely recommended to keep it off in production. Keeping
1271	developing programs can be very useful, however.	1649	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1650	can be very useful, however.
1272		1651
1273	=item C<PERL_ANYEVENT_MODEL>	1652	=item C<PERL_ANYEVENT_MODEL>
1274		1653
1275	This can be used to specify the event model to be used by AnyEvent, before	1654	This can be used to specify the event model to be used by AnyEvent, before
1276	auto detection and -probing kicks in. It must be a string consisting	1655	auto detection and -probing kicks in. It must be a string consisting
…		…
1319		1698
1320	=item C<PERL_ANYEVENT_MAX_FORKS>	1699	=item C<PERL_ANYEVENT_MAX_FORKS>
1321		1700
1322	The maximum number of child processes that C<AnyEvent::Util::fork_call>	1701	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1323	will create in parallel.	1702	will create in parallel.
		1703
		1704	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1705
		1706	The default value for the C<max_outstanding> parameter for the default DNS
		1707	resolver - this is the maximum number of parallel DNS requests that are
		1708	sent to the DNS server.
		1709
		1710	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1711
		1712	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1713	configuration) in the default resolver. When set to the empty string, no
		1714	default config will be used.
		1715
		1716	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1717
		1718	When neither C<ca_file> nor C<ca_path> was specified during
		1719	L<AnyEvent::TLS> context creation, and either of these environment
		1720	variables exist, they will be used to specify CA certificate locations
		1721	instead of a system-dependent default.
		1722
		1723	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1724
		1725	When these are set to C<1>, then the respective modules are not
		1726	loaded. Mostly good for testing AnyEvent itself.
1324		1727
1325	=back	1728	=back
1326		1729
1327	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1730	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1328		1731
…		…
1573	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	1976	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1574	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	1977	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1575	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	1978	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1576	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	1979	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1577	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	1980	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
		1981	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
		1982	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1578	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	1983	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1579	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	1984	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1580	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	1985	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1581	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	1986	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1582		1987
…		…
1611	performance becomes really bad with lots of file descriptors (and few of	2016	performance becomes really bad with lots of file descriptors (and few of
1612	them active), of course, but this was not subject of this benchmark.	2017	them active), of course, but this was not subject of this benchmark.
1613		2018
1614	The C<Event> module has a relatively high setup and callback invocation	2019	The C<Event> module has a relatively high setup and callback invocation
1615	cost, but overall scores in on the third place.	2020	cost, but overall scores in on the third place.
		2021
		2022	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2023	when using its pure perl backend.
1616		2024
1617	C<Glib>'s memory usage is quite a bit higher, but it features a	2025	C<Glib>'s memory usage is quite a bit higher, but it features a
1618	faster callback invocation and overall ends up in the same class as	2026	faster callback invocation and overall ends up in the same class as
1619	C<Event>. However, Glib scales extremely badly, doubling the number of	2027	C<Event>. However, Glib scales extremely badly, doubling the number of
1620	watchers increases the processing time by more than a factor of four,	2028	watchers increases the processing time by more than a factor of four,
…		…
1698	it to another server. This includes deleting the old timeout and creating	2106	it to another server. This includes deleting the old timeout and creating
1699	a new one that moves the timeout into the future.	2107	a new one that moves the timeout into the future.
1700		2108
1701	=head3 Results	2109	=head3 Results
1702		2110
1703	name sockets create request	2111	name sockets create request
1704	EV 20000 69.01 11.16	2112	EV 20000 69.01 11.16
1705	Perl 20000 73.32 35.87	2113	Perl 20000 73.32 35.87
		2114	IOAsync 20000 157.00 98.14 epoll
		2115	IOAsync 20000 159.31 616.06 poll
1706	Event 20000 212.62 257.32	2116	Event 20000 212.62 257.32
1707	Glib 20000 651.16 1896.30	2117	Glib 20000 651.16 1896.30
1708	POE 20000 349.67 12317.24 uses POE::Loop::Event	2118	POE 20000 349.67 12317.24 uses POE::Loop::Event
1709		2119
1710	=head3 Discussion	2120	=head3 Discussion
1711		2121
1712	This benchmark I<does> measure scalability and overall performance of the	2122	This benchmark I<does> measure scalability and overall performance of the
1713	particular event loop.	2123	particular event loop.
…		…
1715	EV is again fastest. Since it is using epoll on my system, the setup time	2125	EV is again fastest. Since it is using epoll on my system, the setup time
1716	is relatively high, though.	2126	is relatively high, though.
1717		2127
1718	Perl surprisingly comes second. It is much faster than the C-based event	2128	Perl surprisingly comes second. It is much faster than the C-based event
1719	loops Event and Glib.	2129	loops Event and Glib.
		2130
		2131	IO::Async performs very well when using its epoll backend, and still quite
		2132	good compared to Glib when using its pure perl backend.
1720		2133
1721	Event suffers from high setup time as well (look at its code and you will	2134	Event suffers from high setup time as well (look at its code and you will
1722	understand why). Callback invocation also has a high overhead compared to	2135	understand why). Callback invocation also has a high overhead compared to
1723	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2136	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1724	uses select or poll in basically all documented configurations.	2137	uses select or poll in basically all documented configurations.
…		…
1787	=item * C-based event loops perform very well with small number of	2200	=item * C-based event loops perform very well with small number of
1788	watchers, as the management overhead dominates.	2201	watchers, as the management overhead dominates.
1789		2202
1790	=back	2203	=back
1791		2204
		2205	=head2 THE IO::Lambda BENCHMARK
		2206
		2207	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2208	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2209	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2210	shouldn't come as a surprise to anybody). As such, the benchmark is
		2211	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2212	very optimal. But how would AnyEvent compare when used without the extra
		2213	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2214
		2215	The benchmark itself creates an echo-server, and then, for 500 times,
		2216	connects to the echo server, sends a line, waits for the reply, and then
		2217	creates the next connection. This is a rather bad benchmark, as it doesn't
		2218	test the efficiency of the framework or much non-blocking I/O, but it is a
		2219	benchmark nevertheless.
		2220
		2221	name runtime
		2222	Lambda/select 0.330 sec
		2223	+ optimized 0.122 sec
		2224	Lambda/AnyEvent 0.327 sec
		2225	+ optimized 0.138 sec
		2226	Raw sockets/select 0.077 sec
		2227	POE/select, components 0.662 sec
		2228	POE/select, raw sockets 0.226 sec
		2229	POE/select, optimized 0.404 sec
		2230
		2231	AnyEvent/select/nb 0.085 sec
		2232	AnyEvent/EV/nb 0.068 sec
		2233	+state machine 0.134 sec
		2234
		2235	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2236	benchmarks actually make blocking connects and use 100% blocking I/O,
		2237	defeating the purpose of an event-based solution. All of the newly
		2238	written AnyEvent benchmarks use 100% non-blocking connects (using
		2239	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2240	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2241	generally require a lot more bookkeeping and event handling than blocking
		2242	connects (which involve a single syscall only).
		2243
		2244	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2245	offers similar expressive power as POE and IO::Lambda, using conventional
		2246	Perl syntax. This means that both the echo server and the client are 100%
		2247	non-blocking, further placing it at a disadvantage.
		2248
		2249	As you can see, the AnyEvent + EV combination even beats the
		2250	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2251	backend easily beats IO::Lambda and POE.
		2252
		2253	And even the 100% non-blocking version written using the high-level (and
		2254	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
		2255	large margin, even though it does all of DNS, tcp-connect and socket I/O
		2256	in a non-blocking way.
		2257
		2258	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2259	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2260	part of the IO::lambda distribution and were used without any changes.
		2261
1792		2262
1793	=head1 SIGNALS	2263	=head1 SIGNALS
1794		2264
1795	AnyEvent currently installs handlers for these signals:	2265	AnyEvent currently installs handlers for these signals:
1796		2266
…		…
1799	=item SIGCHLD	2269	=item SIGCHLD
1800		2270
1801	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2271	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1802	emulation for event loops that do not support them natively. Also, some	2272	emulation for event loops that do not support them natively. Also, some
1803	event loops install a similar handler.	2273	event loops install a similar handler.
		2274
		2275	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2276	AnyEvent will reset it to default, to avoid losing child exit statuses.
1804		2277
1805	=item SIGPIPE	2278	=item SIGPIPE
1806		2279
1807	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2280	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1808	when AnyEvent gets loaded.	2281	when AnyEvent gets loaded.
…		…
1820		2293
1821	=back	2294	=back
1822		2295
1823	=cut	2296	=cut
1824		2297
		2298	undef $SIG{CHLD}
		2299	if $SIG{CHLD} eq 'IGNORE';
		2300
1825	$SIG{PIPE} = sub { }	2301	$SIG{PIPE} = sub { }
1826	unless defined $SIG{PIPE};	2302	unless defined $SIG{PIPE};
		2303
		2304	=head1 RECOMMENDED/OPTIONAL MODULES
		2305
		2306	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2307	it's built-in modules) are required to use it.
		2308
		2309	That does not mean that AnyEvent won't take advantage of some additional
		2310	modules if they are installed.
		2311
		2312	This section epxlains which additional modules will be used, and how they
		2313	affect AnyEvent's operetion.
		2314
		2315	=over 4
		2316
		2317	=item L<Async::Interrupt>
		2318
		2319	This slightly arcane module is used to implement fast signal handling: To
		2320	my knowledge, there is no way to do completely race-free and quick
		2321	signal handling in pure perl. To ensure that signals still get
		2322	delivered, AnyEvent will start an interval timer to wake up perl (and
		2323	catch the signals) with some delay (default is 10 seconds, look for
		2324	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2325
		2326	If this module is available, then it will be used to implement signal
		2327	catching, which means that signals will not be delayed, and the event loop
		2328	will not be interrupted regularly, which is more efficient (And good for
		2329	battery life on laptops).
		2330
		2331	This affects not just the pure-perl event loop, but also other event loops
		2332	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2333
		2334	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2335	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2336	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2337	does nothing for those backends.
		2338
		2339	=item L<EV>
		2340
		2341	This module isn't really "optional", as it is simply one of the backend
		2342	event loops that AnyEvent can use. However, it is simply the best event
		2343	loop available in terms of features, speed and stability: It supports
		2344	the AnyEvent API optimally, implements all the watcher types in XS, does
		2345	automatic timer adjustments even when no monotonic clock is available,
		2346	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2347	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2348	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2349
		2350	=item L<Guard>
		2351
		2352	The guard module, when used, will be used to implement
		2353	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2354	lot less memory), but otherwise doesn't affect guard operation much. It is
		2355	purely used for performance.
		2356
		2357	=item L<JSON> and L<JSON::XS>
		2358
		2359	This module is required when you want to read or write JSON data via
		2360	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2361	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2362
		2363	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2364	installed.
		2365
		2366	=item L<Net::SSLeay>
		2367
		2368	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2369	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2370	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2371
		2372	=item L<Time::HiRes>
		2373
		2374	This module is part of perl since release 5.008. It will be used when the
		2375	chosen event library does not come with a timing source on it's own. The
		2376	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2377	try to use a monotonic clock for timing stability.
		2378
		2379	=back
1827		2380
1828		2381
1829	=head1 FORK	2382	=head1 FORK
1830		2383
1831	Most event libraries are not fork-safe. The ones who are usually are	2384	Most event libraries are not fork-safe. The ones who are usually are
1832	because they rely on inefficient but fork-safe C<select> or C<poll>	2385	because they rely on inefficient but fork-safe C<select> or C<poll>
1833	calls. Only L<EV> is fully fork-aware.	2386	calls. Only L<EV> is fully fork-aware.
1834		2387
1835	If you have to fork, you must either do so I<before> creating your first	2388	If you have to fork, you must either do so I<before> creating your first
1836	watcher OR you must not use AnyEvent at all in the child.	2389	watcher OR you must not use AnyEvent at all in the child OR you must do
		2390	something completely out of the scope of AnyEvent.
1837		2391
1838		2392
1839	=head1 SECURITY CONSIDERATIONS	2393	=head1 SECURITY CONSIDERATIONS
1840		2394
1841	AnyEvent can be forced to load any event model via	2395	AnyEvent can be forced to load any event model via
…		…
1853	use AnyEvent;	2407	use AnyEvent;
1854		2408
1855	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2409	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1856	be used to probe what backend is used and gain other information (which is	2410	be used to probe what backend is used and gain other information (which is
1857	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and	2411	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1858	$ENV{PERL_ANYEGENT_STRICT}.	2412	$ENV{PERL_ANYEVENT_STRICT}.
		2413
		2414	Note that AnyEvent will remove I<all> environment variables starting with
		2415	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2416	enabled.
1859		2417
1860		2418
1861	=head1 BUGS	2419	=head1 BUGS
1862		2420
1863	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2421	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
…		…
1875	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2433	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1876		2434
1877	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2435	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1878	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2436	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1879	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2437	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1880	L<AnyEvent::Impl::POE>.	2438	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1881		2439
1882	Non-blocking file handles, sockets, TCP clients and	2440	Non-blocking file handles, sockets, TCP clients and
1883	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2441	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1884		2442
1885	Asynchronous DNS: L<AnyEvent::DNS>.	2443	Asynchronous DNS: L<AnyEvent::DNS>.
1886		2444
1887	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2445	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2446	L<Coro::Event>,
1888		2447
1889	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2448	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2449	L<AnyEvent::HTTP>.
1890		2450
1891		2451
1892	=head1 AUTHOR	2452	=head1 AUTHOR
1893		2453
1894	Marc Lehmann <schmorp@schmorp.de>	2454	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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