ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.228 by root, Wed Jul 8 01:11:12 2009 UTC vs.
Revision 1.280 by root, Sun Aug 9 23:45:40 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 and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	event loops.	6	and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
…		…
40	=head1 INTRODUCTION/TUTORIAL	40	=head1 INTRODUCTION/TUTORIAL
41		41
42	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
43	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
44	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.
45		53
46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47		55
48	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
49	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
173	my variables are only visible after the statement in which they are	181	my variables are only visible after the statement in which they are
174	declared.	182	declared.
175		183
176	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
177		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	192	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
180		194
181	C<fh> is the Perl I<file handle> (I<not> file descriptor, see below) to	195	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182	watch for events (AnyEvent might or might not keep a reference to this	196	for events (AnyEvent might or might not keep a reference to this file
183	file handle). Note that only file handles pointing to things for which	197	handle). Note that only file handles pointing to things for which
184	non-blocking operation makes sense are allowed. This includes sockets,	198	non-blocking operation makes sense are allowed. This includes sockets,
185	most character devices, pipes, fifos and so on, but not for example files	199	most character devices, pipes, fifos and so on, but not for example files
186	or block devices.	200	or block devices.
187		201
188	C<poll> must be a string that is either C<r> or C<w>, which creates a	202	C<poll> must be a string that is either C<r> or C<w>, which creates a
…		…
209	chomp (my $input = <STDIN>);	223	chomp (my $input = <STDIN>);
210	warn "read: $input\n";	224	warn "read: $input\n";
211	undef $w;	225	undef $w;
212	});	226	});
213		227
214	=head3 GETTING A FILE HANDLE FROM A FILE DESCRIPTOR
215
216	It is not uncommon to only have a file descriptor, while AnyEvent requires
217	a Perl file handle.
218
219	There are basically two methods to convert a file descriptor into a file handle. If you own
220	the file descriptor, you can open it with C<&=>, as in:
221
222	open my $fh, "<&=$fileno" or die "xxx: §!";
223
224	This will "own" the file descriptor, meaning that when C<$fh> is
225	destroyed, it will automatically close the C<$fileno>. Also, note that
226	the open mode (read, write, read/write) must correspond with how the
227	underlying file descriptor was opened.
228
229	In many cases, taking over the file descriptor is now what you want, in
230	which case the only alternative is to dup the file descriptor:
231
232	open my $fh, "<&$fileno" or die "xxx: $!";
233
234	This has the advantage of not closing the file descriptor and the
235	disadvantage of making a slow copy.
236
237	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
		229
		230	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		231
		232	$w = AnyEvent->timer (
		233	after => <fractional_seconds>,
		234	interval => <fractional_seconds>,
		235	cb => <callback>,
		236	);
238		237
239	You can create a time watcher by calling the C<< AnyEvent->timer >>	238	You can create a time watcher by calling the C<< AnyEvent->timer >>
240	method with the following mandatory arguments:	239	method with the following mandatory arguments:
241		240
242	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
…		…
370		369
371	=back	370	=back
372		371
373	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
374		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		375
375	You can watch for signals using a signal watcher, C<signal> is the signal	376	You can watch for signals using a signal watcher, C<signal> is the signal
376	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	377	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
377	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
378		379
379	Although the callback might get passed parameters, their value and	380	Although the callback might get passed parameters, their value and
…		…
384	invocation, and callback invocation will be synchronous. Synchronous means	385	invocation, and callback invocation will be synchronous. Synchronous means
385	that it might take a while until the signal gets handled by the process,	386	that it might take a while until the signal gets handled by the process,
386	but it is guaranteed not to interrupt any other callbacks.	387	but it is guaranteed not to interrupt any other callbacks.
387		388
388	The main advantage of using these watchers is that you can share a signal	389	The main advantage of using these watchers is that you can share a signal
389	between multiple watchers.	390	between multiple watchers, and AnyEvent will ensure that signals will not
		391	interrupt your program at bad times.
390		392
391	This watcher might use C<%SIG>, so programs overwriting those signals	393	This watcher might use C<%SIG> (depending on the event loop used),
392	directly will likely not work correctly.	394	so programs overwriting those signals directly will likely not work
		395	correctly.
393		396
394	Example: exit on SIGINT	397	Example: exit on SIGINT
395		398
396	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
397		400
		401	=head3 Signal Races, Delays and Workarounds
		402
		403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		404	callbacks to signals in a generic way, which is a pity, as you cannot
		405	do race-free signal handling in perl, requiring C libraries for
		406	this. AnyEvent will try to do it's best, which means in some cases,
		407	signals will be delayed. The maximum time a signal might be delayed is
		408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		409	variable can be changed only before the first signal watcher is created,
		410	and should be left alone otherwise. This variable determines how often
		411	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		412	will cause fewer spurious wake-ups, which is better for power and CPU
		413	saving.
		414
		415	All these problems can be avoided by installing the optional
		416	L<Async::Interrupt> module, which works with most event loops. It will not
		417	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		418	(and not with L<POE> currently, as POE does it's own workaround with
		419	one-second latency). For those, you just have to suffer the delays.
		420
398	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
399		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
400	You can also watch on a child process exit and catch its exit status.	425	You can also watch on a child process exit and catch its exit status.
401		426
402	The child process is specified by the C<pid> argument (if set to C<0>, it	427	The child process is specified by the C<pid> argument (one some backends,
403	watches for any child process exit). The watcher will triggered only when	428	using C<0> watches for any child process exit, on others this will
404	the child process has finished and an exit status is available, not on	429	croak). The watcher will be triggered only when the child process has
405	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
406		432
407	The callback will be called with the pid and exit status (as returned by	433	The callback will be called with the pid and exit status (as returned by
408	waitpid), so unlike other watcher types, you I<can> rely on child watcher	434	waitpid), so unlike other watcher types, you I<can> rely on child watcher
409	callback arguments.	435	callback arguments.
410		436
…		…
426		452
427	This means you cannot create a child watcher as the very first	453	This means you cannot create a child watcher as the very first
428	thing in an AnyEvent program, you I<have> to create at least one	454	thing in an AnyEvent program, you I<have> to create at least one
429	watcher before you C<fork> the child (alternatively, you can call	455	watcher before you C<fork> the child (alternatively, you can call
430	C<AnyEvent::detect>).	456	C<AnyEvent::detect>).
		457
		458	As most event loops do not support waiting for child events, they will be
		459	emulated by AnyEvent in most cases, in which the latency and race problems
		460	mentioned in the description of signal watchers apply.
431		461
432	Example: fork a process and wait for it	462	Example: fork a process and wait for it
433		463
434	my $done = AnyEvent->condvar;	464	my $done = AnyEvent->condvar;
435		465
…		…
447	# do something else, then wait for process exit	477	# do something else, then wait for process exit
448	$done->recv;	478	$done->recv;
449		479
450	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
451		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
452	Sometimes there is a need to do something, but it is not so important	484	Sometimes there is a need to do something, but it is not so important
453	to do it instantly, but only when there is nothing better to do. This	485	to do it instantly, but only when there is nothing better to do. This
454	"nothing better to do" is usually defined to be "no other events need	486	"nothing better to do" is usually defined to be "no other events need
455	attention by the event loop".	487	attention by the event loop".
456		488
…		…
482	});	514	});
483	});	515	});
484		516
485	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
486		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
487	If you are familiar with some event loops you will know that all of them	524	If you are familiar with some event loops you will know that all of them
488	require you to run some blocking "loop", "run" or similar function that	525	require you to run some blocking "loop", "run" or similar function that
489	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
490		527
491	AnyEvent is different, it expects somebody else to run the event loop and	528	AnyEvent is slightly different: it expects somebody else to run the event
492	will only block when necessary (usually when told by the user).	529	loop and will only block when necessary (usually when told by the user).
493		530
494	The instrument to do that is called a "condition variable", so called	531	The instrument to do that is called a "condition variable", so called
495	because they represent a condition that must become true.	532	because they represent a condition that must become true.
496		533
		534	Now is probably a good time to look at the examples further below.
		535
497	Condition variables can be created by calling the C<< AnyEvent->condvar	536	Condition variables can be created by calling the C<< AnyEvent->condvar
498	>> method, usually without arguments. The only argument pair allowed is	537	>> method, usually without arguments. The only argument pair allowed is
499
500	C<cb>, which specifies a callback to be called when the condition variable	538	C<cb>, which specifies a callback to be called when the condition variable
501	becomes true, with the condition variable as the first argument (but not	539	becomes true, with the condition variable as the first argument (but not
502	the results).	540	the results).
503		541
504	After creation, the condition variable is "false" until it becomes "true"	542	After creation, the condition variable is "false" until it becomes "true"
…		…
509	Condition variables are similar to callbacks, except that you can	547	Condition variables are similar to callbacks, except that you can
510	optionally wait for them. They can also be called merge points - points	548	optionally wait for them. They can also be called merge points - points
511	in time where multiple outstanding events have been processed. And yet	549	in time where multiple outstanding events have been processed. And yet
512	another way to call them is transactions - each condition variable can be	550	another way to call them is transactions - each condition variable can be
513	used to represent a transaction, which finishes at some point and delivers	551	used to represent a transaction, which finishes at some point and delivers
514	a result.	552	a result. And yet some people know them as "futures" - a promise to
		553	compute/deliver something that you can wait for.
515		554
516	Condition variables are very useful to signal that something has finished,	555	Condition variables are very useful to signal that something has finished,
517	for example, if you write a module that does asynchronous http requests,	556	for example, if you write a module that does asynchronous http requests,
518	then a condition variable would be the ideal candidate to signal the	557	then a condition variable would be the ideal candidate to signal the
519	availability of results. The user can either act when the callback is	558	availability of results. The user can either act when the callback is
…		…
553	after => 1,	592	after => 1,
554	cb => sub { $result_ready->send },	593	cb => sub { $result_ready->send },
555	);	594	);
556		595
557	# this "blocks" (while handling events) till the callback	596	# this "blocks" (while handling events) till the callback
558	# calls send	597	# calls -<send
559	$result_ready->recv;	598	$result_ready->recv;
560		599
561	Example: wait for a timer, but take advantage of the fact that	600	Example: wait for a timer, but take advantage of the fact that condition
562	condition variables are also code references.	601	variables are also callable directly.
563		602
564	my $done = AnyEvent->condvar;	603	my $done = AnyEvent->condvar;
565	my $delay = AnyEvent->timer (after => 5, cb => $done);	604	my $delay = AnyEvent->timer (after => 5, cb => $done);
566	$done->recv;	605	$done->recv;
567		606
…		…
573		612
574	...	613	...
575		614
576	my @info = $couchdb->info->recv;	615	my @info = $couchdb->info->recv;
577		616
578	And this is how you would just ste a callback to be called whenever the	617	And this is how you would just set a callback to be called whenever the
579	results are available:	618	results are available:
580		619
581	$couchdb->info->cb (sub {	620	$couchdb->info->cb (sub {
582	my @info = $_[0]->recv;	621	my @info = $_[0]->recv;
583	});	622	});
…		…
601	immediately from within send.	640	immediately from within send.
602		641
603	Any arguments passed to the C<send> call will be returned by all	642	Any arguments passed to the C<send> call will be returned by all
604	future C<< ->recv >> calls.	643	future C<< ->recv >> calls.
605		644
606	Condition variables are overloaded so one can call them directly	645	Condition variables are overloaded so one can call them directly (as if
607	(as a code reference). Calling them directly is the same as calling	646	they were a code reference). Calling them directly is the same as calling
608	C<send>. Note, however, that many C-based event loops do not handle	647	C<send>.
609	overloading, so as tempting as it may be, passing a condition variable
610	instead of a callback does not work. Both the pure perl and EV loops
611	support overloading, however, as well as all functions that use perl to
612	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
613	example).
614		648
615	=item $cv->croak ($error)	649	=item $cv->croak ($error)
616		650
617	Similar to send, but causes all call's to C<< ->recv >> to invoke	651	Similar to send, but causes all call's to C<< ->recv >> to invoke
618	C<Carp::croak> with the given error message/object/scalar.	652	C<Carp::croak> with the given error message/object/scalar.
619		653
620	This can be used to signal any errors to the condition variable	654	This can be used to signal any errors to the condition variable
621	user/consumer.	655	user/consumer. Doing it this way instead of calling C<croak> directly
		656	delays the error detetcion, but has the overwhelmign advantage that it
		657	diagnoses the error at the place where the result is expected, and not
		658	deep in some event clalback without connection to the actual code causing
		659	the problem.
622		660
623	=item $cv->begin ([group callback])	661	=item $cv->begin ([group callback])
624		662
625	=item $cv->end	663	=item $cv->end
626		664
…		…
628	one. For example, a function that pings many hosts in parallel might want	666	one. For example, a function that pings many hosts in parallel might want
629	to use a condition variable for the whole process.	667	to use a condition variable for the whole process.
630		668
631	Every call to C<< ->begin >> will increment a counter, and every call to	669	Every call to C<< ->begin >> will increment a counter, and every call to
632	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
633	>>, the (last) callback passed to C<begin> will be executed. That callback	671	>>, the (last) callback passed to C<begin> will be executed, passing the
634	is I<supposed> to call C<< ->send >>, but that is not required. If no	672	condvar as first argument. That callback is I<supposed> to call C<< ->send
635	callback was set, C<send> will be called without any arguments.	673	>>, but that is not required. If no group callback was set, C<send> will
		674	be called without any arguments.
636		675
637	You can think of C<< $cv->send >> giving you an OR condition (one call	676	You can think of C<< $cv->send >> giving you an OR condition (one call
638	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	677	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
639	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	678	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
640		679
…		…
667	begung can potentially be zero:	706	begung can potentially be zero:
668		707
669	my $cv = AnyEvent->condvar;	708	my $cv = AnyEvent->condvar;
670		709
671	my %result;	710	my %result;
672	$cv->begin (sub { $cv->send (\%result) });	711	$cv->begin (sub { shift->send (\%result) });
673		712
674	for my $host (@list_of_hosts) {	713	for my $host (@list_of_hosts) {
675	$cv->begin;	714	$cv->begin;
676	ping_host_then_call_callback $host, sub {	715	ping_host_then_call_callback $host, sub {
677	$result{$host} = ...;	716	$result{$host} = ...;
…		…
722	function will call C<croak>.	761	function will call C<croak>.
723		762
724	In list context, all parameters passed to C<send> will be returned,	763	In list context, all parameters passed to C<send> will be returned,
725	in scalar context only the first one will be returned.	764	in scalar context only the first one will be returned.
726		765
		766	Note that doing a blocking wait in a callback is not supported by any
		767	event loop, that is, recursive invocation of a blocking C<< ->recv
		768	>> is not allowed, and the C<recv> call will C<croak> if such a
		769	condition is detected. This condition can be slightly loosened by using
		770	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		771	any thread that doesn't run the event loop itself.
		772
727	Not all event models support a blocking wait - some die in that case	773	Not all event models support a blocking wait - some die in that case
728	(programs might want to do that to stay interactive), so I<if you are	774	(programs might want to do that to stay interactive), so I<if you are
729	using this from a module, never require a blocking wait>, but let the	775	using this from a module, never require a blocking wait>. Instead, let the
730	caller decide whether the call will block or not (for example, by coupling	776	caller decide whether the call will block or not (for example, by coupling
731	condition variables with some kind of request results and supporting	777	condition variables with some kind of request results and supporting
732	callbacks so the caller knows that getting the result will not block,	778	callbacks so the caller knows that getting the result will not block,
733	while still supporting blocking waits if the caller so desires).	779	while still supporting blocking waits if the caller so desires).
734		780
735	Another reason I<never> to C<< ->recv >> in a module is that you cannot
736	sensibly have two C<< ->recv >>'s in parallel, as that would require
737	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
738	can supply.
739
740	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
741	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
742	versions and also integrates coroutines into AnyEvent, making blocking
743	C<< ->recv >> calls perfectly safe as long as they are done from another
744	coroutine (one that doesn't run the event loop).
745
746	You can ensure that C<< -recv >> never blocks by setting a callback and	781	You can ensure that C<< -recv >> never blocks by setting a callback and
747	only calling C<< ->recv >> from within that callback (or at a later	782	only calling C<< ->recv >> from within that callback (or at a later
748	time). This will work even when the event loop does not support blocking	783	time). This will work even when the event loop does not support blocking
749	waits otherwise.	784	waits otherwise.
750		785
…		…
756	=item $cb = $cv->cb ($cb->($cv))	791	=item $cb = $cv->cb ($cb->($cv))
757		792
758	This is a mutator function that returns the callback set and optionally	793	This is a mutator function that returns the callback set and optionally
759	replaces it before doing so.	794	replaces it before doing so.
760		795
761	The callback will be called when the condition becomes "true", i.e. when	796	The callback will be called when the condition becomes (or already was)
762	C<send> or C<croak> are called, with the only argument being the condition	797	"true", i.e. when C<send> or C<croak> are called (or were called), with
763	variable itself. Calling C<recv> inside the callback or at any later time	798	the only argument being the condition variable itself. Calling C<recv>
764	is guaranteed not to block.	799	inside the callback or at any later time is guaranteed not to block.
765		800
766	=back	801	=back
767		802
		803	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		804
		805	The available backend classes are (every class has its own manpage):
		806
		807	=over 4
		808
		809	=item Backends that are autoprobed when no other event loop can be found.
		810
		811	EV is the preferred backend when no other event loop seems to be in
		812	use. If EV is not installed, then AnyEvent will fall back to its own
		813	pure-perl implementation, which is available everywhere as it comes with
		814	AnyEvent itself.
		815
		816	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		818
		819	=item Backends that are transparently being picked up when they are used.
		820
		821	These will be used when they are currently loaded when the first watcher
		822	is created, in which case it is assumed that the application is using
		823	them. This means that AnyEvent will automatically pick the right backend
		824	when the main program loads an event module before anything starts to
		825	create watchers. Nothing special needs to be done by the main program.
		826
		827	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		828	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		829	AnyEvent::Impl::Tk based on Tk, very broken.
		830	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		831	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		832	AnyEvent::Impl::Irssi used when running within irssi.
		833
		834	=item Backends with special needs.
		835
		836	Qt requires the Qt::Application to be instantiated first, but will
		837	otherwise be picked up automatically. As long as the main program
		838	instantiates the application before any AnyEvent watchers are created,
		839	everything should just work.
		840
		841	AnyEvent::Impl::Qt based on Qt.
		842
		843	Support for IO::Async can only be partial, as it is too broken and
		844	architecturally limited to even support the AnyEvent API. It also
		845	is the only event loop that needs the loop to be set explicitly, so
		846	it can only be used by a main program knowing about AnyEvent. See
		847	L<AnyEvent::Impl::Async> for the gory details.
		848
		849	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		850
		851	=item Event loops that are indirectly supported via other backends.
		852
		853	Some event loops can be supported via other modules:
		854
		855	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		856
		857	B<WxWidgets> has no support for watching file handles. However, you can
		858	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		859	polls 20 times per second, which was considered to be too horrible to even
		860	consider for AnyEvent.
		861
		862	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		863	backend, so it can be supported through POE.
		864
		865	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		866	load L<POE> when detecting them, in the hope that POE will pick them up,
		867	in which case everything will be automatic.
		868
		869	=back
		870
768	=head1 GLOBAL VARIABLES AND FUNCTIONS	871	=head1 GLOBAL VARIABLES AND FUNCTIONS
769		872
		873	These are not normally required to use AnyEvent, but can be useful to
		874	write AnyEvent extension modules.
		875
770	=over 4	876	=over 4
771		877
772	=item $AnyEvent::MODEL	878	=item $AnyEvent::MODEL
773		879
774	Contains C<undef> until the first watcher is being created. Then it	880	Contains C<undef> until the first watcher is being created, before the
		881	backend has been autodetected.
		882
775	contains the event model that is being used, which is the name of the	883	Afterwards it contains the event model that is being used, which is the
776	Perl class implementing the model. This class is usually one of the	884	name of the Perl class implementing the model. This class is usually one
777	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	885	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
778	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	886	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
779		887	will be C<urxvt::anyevent>).
780	The known classes so far are:
781
782	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
783	AnyEvent::Impl::Event based on Event, second best choice.
784	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
785	AnyEvent::Impl::Glib based on Glib, third-best choice.
786	AnyEvent::Impl::Tk based on Tk, very bad choice.
787	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
788	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
789	AnyEvent::Impl::POE based on POE, not generic enough for full support.
790
791	# warning, support for IO::Async is only partial, as it is too broken
792	# and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
793	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
794
795	There is no support for WxWidgets, as WxWidgets has no support for
796	watching file handles. However, you can use WxWidgets through the
797	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
798	second, which was considered to be too horrible to even consider for
799	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
800	it's adaptor.
801
802	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
803	autodetecting them.
804		888
805	=item AnyEvent::detect	889	=item AnyEvent::detect
806		890
807	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	891	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
808	if necessary. You should only call this function right before you would	892	if necessary. You should only call this function right before you would
809	have created an AnyEvent watcher anyway, that is, as late as possible at	893	have created an AnyEvent watcher anyway, that is, as late as possible at
810	runtime.	894	runtime, and not e.g. while initialising of your module.
		895
		896	If you need to do some initialisation before AnyEvent watchers are
		897	created, use C<post_detect>.
811		898
812	=item $guard = AnyEvent::post_detect { BLOCK }	899	=item $guard = AnyEvent::post_detect { BLOCK }
813		900
814	Arranges for the code block to be executed as soon as the event model is	901	Arranges for the code block to be executed as soon as the event model is
815	autodetected (or immediately if this has already happened).	902	autodetected (or immediately if this has already happened).
816		903
		904	The block will be executed I<after> the actual backend has been detected
		905	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		906	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		907	other initialisations - see the sources of L<AnyEvent::Strict> or
		908	L<AnyEvent::AIO> to see how this is used.
		909
		910	The most common usage is to create some global watchers, without forcing
		911	event module detection too early, for example, L<AnyEvent::AIO> creates
		912	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		913	avoid autodetecting the event module at load time.
		914
817	If called in scalar or list context, then it creates and returns an object	915	If called in scalar or list context, then it creates and returns an object
818	that automatically removes the callback again when it is destroyed. See	916	that automatically removes the callback again when it is destroyed (or
		917	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
819	L<Coro::BDB> for a case where this is useful.	918	a case where this is useful.
		919
		920	Example: Create a watcher for the IO::AIO module and store it in
		921	C<$WATCHER>. Only do so after the event loop is initialised, though.
		922
		923	our WATCHER;
		924
		925	my $guard = AnyEvent::post_detect {
		926	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		927	};
		928
		929	# the ||= is important in case post_detect immediately runs the block,
		930	# as to not clobber the newly-created watcher. assigning both watcher and
		931	# post_detect guard to the same variable has the advantage of users being
		932	# able to just C<undef $WATCHER> if the watcher causes them grief.
		933
		934	$WATCHER ||= $guard;
820		935
821	=item @AnyEvent::post_detect	936	=item @AnyEvent::post_detect
822		937
823	If there are any code references in this array (you can C<push> to it	938	If there are any code references in this array (you can C<push> to it
824	before or after loading AnyEvent), then they will called directly after	939	before or after loading AnyEvent), then they will called directly after
825	the event loop has been chosen.	940	the event loop has been chosen.
826		941
827	You should check C<$AnyEvent::MODEL> before adding to this array, though:	942	You should check C<$AnyEvent::MODEL> before adding to this array, though:
828	if it contains a true value then the event loop has already been detected,	943	if it is defined then the event loop has already been detected, and the
829	and the array will be ignored.	944	array will be ignored.
830		945
831	Best use C<AnyEvent::post_detect { BLOCK }> instead.	946	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		947	it,as it takes care of these details.
		948
		949	This variable is mainly useful for modules that can do something useful
		950	when AnyEvent is used and thus want to know when it is initialised, but do
		951	not need to even load it by default. This array provides the means to hook
		952	into AnyEvent passively, without loading it.
832		953
833	=back	954	=back
834		955
835	=head1 WHAT TO DO IN A MODULE	956	=head1 WHAT TO DO IN A MODULE
836		957
…		…
891		1012
892		1013
893	=head1 OTHER MODULES	1014	=head1 OTHER MODULES
894		1015
895	The following is a non-exhaustive list of additional modules that use	1016	The following is a non-exhaustive list of additional modules that use
896	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1017	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
897	in the same program. Some of the modules come with AnyEvent, some are	1018	modules and other event loops in the same program. Some of the modules
898	available via CPAN.	1019	come with AnyEvent, most are available via CPAN.
899		1020
900	=over 4	1021	=over 4
901		1022
902	=item L<AnyEvent::Util>	1023	=item L<AnyEvent::Util>
903		1024
…		…
912		1033
913	=item L<AnyEvent::Handle>	1034	=item L<AnyEvent::Handle>
914		1035
915	Provide read and write buffers, manages watchers for reads and writes,	1036	Provide read and write buffers, manages watchers for reads and writes,
916	supports raw and formatted I/O, I/O queued and fully transparent and	1037	supports raw and formatted I/O, I/O queued and fully transparent and
917	non-blocking SSL/TLS.	1038	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
918		1039
919	=item L<AnyEvent::DNS>	1040	=item L<AnyEvent::DNS>
920		1041
921	Provides rich asynchronous DNS resolver capabilities.	1042	Provides rich asynchronous DNS resolver capabilities.
922		1043
…		…
950		1071
951	=item L<AnyEvent::GPSD>	1072	=item L<AnyEvent::GPSD>
952		1073
953	A non-blocking interface to gpsd, a daemon delivering GPS information.	1074	A non-blocking interface to gpsd, a daemon delivering GPS information.
954		1075
		1076	=item L<AnyEvent::IRC>
		1077
		1078	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1079
		1080	=item L<AnyEvent::XMPP>
		1081
		1082	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1083	Net::XMPP2>.
		1084
955	=item L<AnyEvent::IGS>	1085	=item L<AnyEvent::IGS>
956		1086
957	A non-blocking interface to the Internet Go Server protocol (used by	1087	A non-blocking interface to the Internet Go Server protocol (used by
958	L<App::IGS>).	1088	L<App::IGS>).
959		1089
960	=item L<AnyEvent::IRC>
961
962	AnyEvent based IRC client module family (replacing the older Net::IRC3).
963
964	=item L<Net::XMPP2>
965
966	AnyEvent based XMPP (Jabber protocol) module family.
967
968	=item L<Net::FCP>	1090	=item L<Net::FCP>
969		1091
970	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1092	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
971	of AnyEvent.	1093	of AnyEvent.
972		1094
…		…
976		1098
977	=item L<Coro>	1099	=item L<Coro>
978		1100
979	Has special support for AnyEvent via L<Coro::AnyEvent>.	1101	Has special support for AnyEvent via L<Coro::AnyEvent>.
980		1102
981	=item L<IO::Lambda>
982
983	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
984
985	=back	1103	=back
986		1104
987	=cut	1105	=cut
988		1106
989	package AnyEvent;	1107	package AnyEvent;
990		1108
		1109	# basically a tuned-down version of common::sense
		1110	sub common_sense {
991	no warnings;	1111	# no warnings
		1112	${^WARNING_BITS} ^= ${^WARNING_BITS};
992	use strict qw(vars subs);	1113	# use strict vars subs
		1114	$^H |= 0x00000600;
		1115	}
993		1116
		1117	BEGIN { AnyEvent::common_sense }
		1118
994	use Carp;	1119	use Carp ();
995		1120
996	our $VERSION = 4.8;	1121	our $VERSION = '5.0';
997	our $MODEL;	1122	our $MODEL;
998		1123
999	our $AUTOLOAD;	1124	our $AUTOLOAD;
1000	our @ISA;	1125	our @ISA;
1001		1126
1002	our @REGISTRY;	1127	our @REGISTRY;
1003		1128
1004	our $WIN32;	1129	our $WIN32;
		1130
		1131	our $VERBOSE;
1005		1132
1006	BEGIN {	1133	BEGIN {
1007	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1134	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1008	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1135	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1009		1136
1010	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1137	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1011	if ${^TAINT};	1138	if ${^TAINT};
1012	}
1013		1139
1014	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1140	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1141
		1142	}
		1143
		1144	our $MAX_SIGNAL_LATENCY = 10;
1015		1145
1016	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1146	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1017		1147
1018	{	1148	{
1019	my $idx;	1149	my $idx;
…		…
1021	for reverse split /\s*,\s*/,	1151	for reverse split /\s*,\s*/,
1022	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1152	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1023	}	1153	}
1024		1154
1025	my @models = (	1155	my @models = (
1026	[EV:: => AnyEvent::Impl::EV::],	1156	[EV:: => AnyEvent::Impl::EV:: , 1],
1027	[Event:: => AnyEvent::Impl::Event::],
1028	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1029	# everything below here will not be autoprobed	1158	# everything below here will not (normally) be autoprobed
1030	# as the pureperl backend should work everywhere	1159	# as the pureperl backend should work everywhere
1031	# and is usually faster	1160	# and is usually faster
		1161	[Event:: => AnyEvent::Impl::Event::, 1],
		1162	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1163	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1164	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1032	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1165	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1033	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1034	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1035	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1166	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1036	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1167	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1037	[Wx:: => AnyEvent::Impl::POE::],	1168	[Wx:: => AnyEvent::Impl::POE::],
1038	[Prima:: => AnyEvent::Impl::POE::],	1169	[Prima:: => AnyEvent::Impl::POE::],
1039	# IO::Async is just too broken - we would need workaorunds for its	1170	# IO::Async is just too broken - we would need workarounds for its
1040	# byzantine signal and broken child handling, among others.	1171	# byzantine signal and broken child handling, among others.
1041	# IO::Async is rather hard to detect, as it doesn't have any	1172	# IO::Async is rather hard to detect, as it doesn't have any
1042	# obvious default class.	1173	# obvious default class.
1043	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1044	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1045	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1176	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1177	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1046	);	1178	);
1047		1179
1048	our %method = map +($_ => 1),	1180	our %method = map +($_ => 1),
1049	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1181	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1050		1182
…		…
1054	my ($cb) = @_;	1186	my ($cb) = @_;
1055		1187
1056	if ($MODEL) {	1188	if ($MODEL) {
1057	$cb->();	1189	$cb->();
1058		1190
1059	1	1191	undef
1060	} else {	1192	} else {
1061	push @post_detect, $cb;	1193	push @post_detect, $cb;
1062		1194
1063	defined wantarray	1195	defined wantarray
1064	? bless \$cb, "AnyEvent::Util::postdetect"	1196	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1070	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1202	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1071	}	1203	}
1072		1204
1073	sub detect() {	1205	sub detect() {
1074	unless ($MODEL) {	1206	unless ($MODEL) {
1075	no strict 'refs';
1076	local $SIG{__DIE__};	1207	local $SIG{__DIE__};
1077		1208
1078	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1209	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1079	my $model = "AnyEvent::Impl::$1";	1210	my $model = "AnyEvent::Impl::$1";
1080	if (eval "require $model") {	1211	if (eval "require $model") {
1081	$MODEL = $model;	1212	$MODEL = $model;
1082	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1213	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1083	} else {	1214	} else {
1084	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1215	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1085	}	1216	}
1086	}	1217	}
1087		1218
1088	# check for already loaded models	1219	# check for already loaded models
1089	unless ($MODEL) {	1220	unless ($MODEL) {
1090	for (@REGISTRY, @models) {	1221	for (@REGISTRY, @models) {
1091	my ($package, $model) = @$_;	1222	my ($package, $model) = @$_;
1092	if (${"$package\::VERSION"} > 0) {	1223	if (${"$package\::VERSION"} > 0) {
1093	if (eval "require $model") {	1224	if (eval "require $model") {
1094	$MODEL = $model;	1225	$MODEL = $model;
1095	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1226	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1096	last;	1227	last;
1097	}	1228	}
1098	}	1229	}
1099	}	1230	}
1100		1231
1101	unless ($MODEL) {	1232	unless ($MODEL) {
1102	# try to load a model	1233	# try to autoload a model
1103
1104	for (@REGISTRY, @models) {	1234	for (@REGISTRY, @models) {
1105	my ($package, $model) = @$_;	1235	my ($package, $model, $autoload) = @$_;
		1236	if (
		1237	$autoload
1106	if (eval "require $package"	1238	and eval "require $package"
1107	and ${"$package\::VERSION"} > 0	1239	and ${"$package\::VERSION"} > 0
1108	and eval "require $model") {	1240	and eval "require $model"
		1241	) {
1109	$MODEL = $model;	1242	$MODEL = $model;
1110	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1243	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1111	last;	1244	last;
1112	}	1245	}
1113	}	1246	}
1114		1247
1115	$MODEL	1248	$MODEL
…		…
1131		1264
1132	sub AUTOLOAD {	1265	sub AUTOLOAD {
1133	(my $func = $AUTOLOAD) =~ s/.*://;	1266	(my $func = $AUTOLOAD) =~ s/.*://;
1134		1267
1135	$method{$func}	1268	$method{$func}
1136	or croak "$func: not a valid method for AnyEvent objects";	1269	or Carp::croak "$func: not a valid method for AnyEvent objects";
1137		1270
1138	detect unless $MODEL;	1271	detect unless $MODEL;
1139		1272
1140	my $class = shift;	1273	my $class = shift;
1141	$class->$func (@_);	1274	$class->$func (@_);
…		…
1146	# allow only one watcher per fd, so we dup it to get a different one).	1279	# allow only one watcher per fd, so we dup it to get a different one).
1147	sub _dupfh($$;$$) {	1280	sub _dupfh($$;$$) {
1148	my ($poll, $fh, $r, $w) = @_;	1281	my ($poll, $fh, $r, $w) = @_;
1149		1282
1150	# cygwin requires the fh mode to be matching, unix doesn't	1283	# cygwin requires the fh mode to be matching, unix doesn't
1151	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1284	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1152	: $poll eq "w" ? ($w, ">")
1153	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1154		1285
1155	open my $fh2, "$mode&" . fileno $fh	1286	open my $fh2, $mode, $fh
1156	or die "cannot dup() filehandle: $!,";	1287	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1157		1288
1158	# we assume CLOEXEC is already set by perl in all important cases	1289	# we assume CLOEXEC is already set by perl in all important cases
1159		1290
1160	($fh2, $rw)	1291	($fh2, $rw)
1161	}	1292	}
1162		1293
		1294	=head1 SIMPLIFIED AE API
		1295
		1296	Starting with version 5.0, AnyEvent officially supports a second, much
		1297	simpler, API that is designed to reduce the calling, typing and memory
		1298	overhead.
		1299
		1300	See the L<AE> manpage for details.
		1301
		1302	=cut
		1303
		1304	package AE;
		1305
		1306	our $VERSION = $AnyEvent::VERSION;
		1307
		1308	sub io($$$) {
		1309	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1310	}
		1311
		1312	sub timer($$$) {
		1313	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1314	}
		1315
		1316	sub signal($$) {
		1317	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1318	}
		1319
		1320	sub child($$) {
		1321	AnyEvent->child (pid => $_[0], cb => $_[1])
		1322	}
		1323
		1324	sub idle($) {
		1325	AnyEvent->idle (cb => $_[0])
		1326	}
		1327
		1328	sub cv(;&) {
		1329	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1330	}
		1331
		1332	sub now() {
		1333	AnyEvent->now
		1334	}
		1335
		1336	sub now_update() {
		1337	AnyEvent->now_update
		1338	}
		1339
		1340	sub time() {
		1341	AnyEvent->time
		1342	}
		1343
1163	package AnyEvent::Base;	1344	package AnyEvent::Base;
1164		1345
1165	# default implementations for many methods	1346	# default implementations for many methods
1166		1347
1167	BEGIN {	1348	sub _time {
		1349	# probe for availability of Time::HiRes
1168	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1350	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1351	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1169	*_time = \&Time::HiRes::time;	1352	*_time = \&Time::HiRes::time;
1170	# if (eval "use POSIX (); (POSIX::times())...	1353	# if (eval "use POSIX (); (POSIX::times())...
1171	} else {	1354	} else {
		1355	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1172	*_time = sub { time }; # epic fail	1356	*_time = sub { time }; # epic fail
1173	}	1357	}
		1358
		1359	&_time
1174	}	1360	}
1175		1361
1176	sub time { _time }	1362	sub time { _time }
1177	sub now { _time }	1363	sub now { _time }
1178	sub now_update { }	1364	sub now_update { }
…		…
1183	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1369	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1184	}	1370	}
1185		1371
1186	# default implementation for ->signal	1372	# default implementation for ->signal
1187		1373
		1374	our $HAVE_ASYNC_INTERRUPT;
		1375
		1376	sub _have_async_interrupt() {
		1377	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1378	&& eval "use Async::Interrupt 1.0 (); 1")
		1379	unless defined $HAVE_ASYNC_INTERRUPT;
		1380
		1381	$HAVE_ASYNC_INTERRUPT
		1382	}
		1383
1188	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1384	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1385	our (%SIG_ASY, %SIG_ASY_W);
		1386	our ($SIG_COUNT, $SIG_TW);
1189		1387
1190	sub _signal_exec {	1388	sub _signal_exec {
		1389	$HAVE_ASYNC_INTERRUPT
		1390	? $SIGPIPE_R->drain
1191	sysread $SIGPIPE_R, my $dummy, 4;	1391	: sysread $SIGPIPE_R, my $dummy, 9;
1192		1392
1193	while (%SIG_EV) {	1393	while (%SIG_EV) {
1194	for (keys %SIG_EV) {	1394	for (keys %SIG_EV) {
1195	delete $SIG_EV{$_};	1395	delete $SIG_EV{$_};
1196	$_->() for values %{ $SIG_CB{$_} || {} };	1396	$_->() for values %{ $SIG_CB{$_} || {} };
1197	}	1397	}
1198	}	1398	}
1199	}	1399	}
1200		1400
		1401	# install a dummy wakeup watcher to reduce signal catching latency
		1402	sub _sig_add() {
		1403	unless ($SIG_COUNT++) {
		1404	# try to align timer on a full-second boundary, if possible
		1405	my $NOW = AE::now;
		1406
		1407	$SIG_TW = AE::timer
		1408	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1409	$MAX_SIGNAL_LATENCY,
		1410	sub { } # just for the PERL_ASYNC_CHECK
		1411	;
		1412	}
		1413	}
		1414
		1415	sub _sig_del {
		1416	undef $SIG_TW
		1417	unless --$SIG_COUNT;
		1418	}
		1419
		1420	our $_sig_name_init; $_sig_name_init = sub {
		1421	eval q{ # poor man's autoloading
		1422	undef $_sig_name_init;
		1423
		1424	if (_have_async_interrupt) {
		1425	*sig2num = \&Async::Interrupt::sig2num;
		1426	*sig2name = \&Async::Interrupt::sig2name;
		1427	} else {
		1428	require Config;
		1429
		1430	my %signame2num;
		1431	@signame2num{ split ' ', $Config::Config{sig_name} }
		1432	= split ' ', $Config::Config{sig_num};
		1433
		1434	my @signum2name;
		1435	@signum2name[values %signame2num] = keys %signame2num;
		1436
		1437	*sig2num = sub($) {
		1438	$_[0] > 0 ? shift : $signame2num{+shift}
		1439	};
		1440	*sig2name = sub ($) {
		1441	$_[0] > 0 ? $signum2name[+shift] : shift
		1442	};
		1443	}
		1444	};
		1445	die if $@;
		1446	};
		1447
		1448	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1449	sub sig2name($) { &$_sig_name_init; &sig2name }
		1450
1201	sub signal {	1451	sub signal {
1202	my (undef, %arg) = @_;	1452	eval q{ # poor man's autoloading {}
		1453	# probe for availability of Async::Interrupt
		1454	if (_have_async_interrupt) {
		1455	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1203		1456
1204	unless ($SIGPIPE_R) {	1457	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1205	require Fcntl;	1458	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1206		1459
1207	if (AnyEvent::WIN32) {
1208	require AnyEvent::Util;
1209
1210	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1211	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1212	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1213	} else {	1460	} else {
		1461	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1462
		1463	require Fcntl;
		1464
		1465	if (AnyEvent::WIN32) {
		1466	require AnyEvent::Util;
		1467
		1468	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1470	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1471	} else {
1214	pipe $SIGPIPE_R, $SIGPIPE_W;	1472	pipe $SIGPIPE_R, $SIGPIPE_W;
1215	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1473	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1216	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1474	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1217		1475
1218	# not strictly required, as $^F is normally 2, but let's make sure...	1476	# not strictly required, as $^F is normally 2, but let's make sure...
1219	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1477	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1220	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1478	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1479	}
		1480
		1481	$SIGPIPE_R
		1482	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1483
		1484	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1221	}	1485	}
1222		1486
1223	$SIGPIPE_R	1487	*signal = sub {
1224	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1488	my (undef, %arg) = @_;
1225		1489
1226	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1227	}
1228
1229	my $signal = uc $arg{signal}	1490	my $signal = uc $arg{signal}
1230	or Carp::croak "required option 'signal' is missing";	1491	or Carp::croak "required option 'signal' is missing";
1231		1492
		1493	if ($HAVE_ASYNC_INTERRUPT) {
		1494	# async::interrupt
		1495
		1496	$signal = sig2num $signal;
1232	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1497	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1498
		1499	$SIG_ASY{$signal} ||= new Async::Interrupt
		1500	cb => sub { undef $SIG_EV{$signal} },
		1501	signal => $signal,
		1502	pipe => [$SIGPIPE_R->filenos],
		1503	pipe_autodrain => 0,
		1504	;
		1505
		1506	} else {
		1507	# pure perl
		1508
		1509	# AE::Util has been loaded in signal
		1510	$signal = sig2name $signal;
		1511	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1512
1233	$SIG{$signal} ||= sub {	1513	$SIG{$signal} ||= sub {
1234	local $!;	1514	local $!;
1235	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1515	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1236	undef $SIG_EV{$signal};	1516	undef $SIG_EV{$signal};
		1517	};
		1518
		1519	# can't do signal processing without introducing races in pure perl,
		1520	# so limit the signal latency.
		1521	_sig_add;
		1522	}
		1523
		1524	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1525	};
		1526
		1527	*AnyEvent::Base::signal::DESTROY = sub {
		1528	my ($signal, $cb) = @{$_[0]};
		1529
		1530	_sig_del;
		1531
		1532	delete $SIG_CB{$signal}{$cb};
		1533
		1534	$HAVE_ASYNC_INTERRUPT
		1535	? delete $SIG_ASY{$signal}
		1536	: # delete doesn't work with older perls - they then
		1537	# print weird messages, or just unconditionally exit
		1538	# instead of getting the default action.
		1539	undef $SIG{$signal}
		1540	unless keys %{ $SIG_CB{$signal} };
		1541	};
1237	};	1542	};
1238		1543	die if $@;
1239	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1544	&signal
1240	}
1241
1242	sub AnyEvent::Base::signal::DESTROY {
1243	my ($signal, $cb) = @{$_[0]};
1244
1245	delete $SIG_CB{$signal}{$cb};
1246
1247	# delete doesn't work with older perls - they then
1248	# print weird messages, or just unconditionally exit
1249	# instead of getting the default action.
1250	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1251	}	1545	}
1252		1546
1253	# default implementation for ->child	1547	# default implementation for ->child
1254		1548
1255	our %PID_CB;	1549	our %PID_CB;
1256	our $CHLD_W;	1550	our $CHLD_W;
1257	our $CHLD_DELAY_W;	1551	our $CHLD_DELAY_W;
1258	our $WNOHANG;	1552	our $WNOHANG;
1259		1553
		1554	sub _emit_childstatus($$) {
		1555	my (undef, $rpid, $rstatus) = @_;
		1556
		1557	$_->($rpid, $rstatus)
		1558	for values %{ $PID_CB{$rpid} || {} },
		1559	values %{ $PID_CB{0} || {} };
		1560	}
		1561
1260	sub _sigchld {	1562	sub _sigchld {
		1563	my $pid;
		1564
		1565	AnyEvent->_emit_childstatus ($pid, $?)
1261	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1566	while ($pid = waitpid -1, $WNOHANG) > 0;
1262	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1263	(values %{ $PID_CB{0} || {} });
1264	}
1265	}	1567	}
1266		1568
1267	sub child {	1569	sub child {
1268	my (undef, %arg) = @_;	1570	my (undef, %arg) = @_;
1269		1571
1270	defined (my $pid = $arg{pid} + 0)	1572	defined (my $pid = $arg{pid} + 0)
1271	or Carp::croak "required option 'pid' is missing";	1573	or Carp::croak "required option 'pid' is missing";
1272		1574
1273	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1575	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1274		1576
		1577	# WNOHANG is almost cetrainly 1 everywhere
		1578	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
		1579	? 1
1275	$WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1580	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1276		1581
1277	unless ($CHLD_W) {	1582	unless ($CHLD_W) {
1278	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1583	$CHLD_W = AE::signal CHLD => \&_sigchld;
1279	# child could be a zombie already, so make at least one round	1584	# child could be a zombie already, so make at least one round
1280	&_sigchld;	1585	&_sigchld;
1281	}	1586	}
1282		1587
1283	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1588	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1309	# never use more then 50% of the time for the idle watcher,	1614	# never use more then 50% of the time for the idle watcher,
1310	# within some limits	1615	# within some limits
1311	$w = 0.0001 if $w < 0.0001;	1616	$w = 0.0001 if $w < 0.0001;
1312	$w = 5 if $w > 5;	1617	$w = 5 if $w > 5;
1313		1618
1314	$w = AnyEvent->timer (after => $w, cb => $rcb);	1619	$w = AE::timer $w, 0, $rcb;
1315	} else {	1620	} else {
1316	# clean up...	1621	# clean up...
1317	undef $w;	1622	undef $w;
1318	undef $rcb;	1623	undef $rcb;
1319	}	1624	}
1320	};	1625	};
1321		1626
1322	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1627	$w = AE::timer 0.05, 0, $rcb;
1323		1628
1324	bless \\$cb, "AnyEvent::Base::idle"	1629	bless \\$cb, "AnyEvent::Base::idle"
1325	}	1630	}
1326		1631
1327	sub AnyEvent::Base::idle::DESTROY {	1632	sub AnyEvent::Base::idle::DESTROY {
…		…
1332		1637
1333	our @ISA = AnyEvent::CondVar::Base::;	1638	our @ISA = AnyEvent::CondVar::Base::;
1334		1639
1335	package AnyEvent::CondVar::Base;	1640	package AnyEvent::CondVar::Base;
1336		1641
1337	use overload	1642	#use overload
1338	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1643	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1339	fallback => 1;	1644	# fallback => 1;
		1645
		1646	# save 300+ kilobytes by dirtily hardcoding overloading
		1647	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1648	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1649	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1650	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1651
		1652	our $WAITING;
1340		1653
1341	sub _send {	1654	sub _send {
1342	# nop	1655	# nop
1343	}	1656	}
1344		1657
…		…
1357	sub ready {	1670	sub ready {
1358	$_[0]{_ae_sent}	1671	$_[0]{_ae_sent}
1359	}	1672	}
1360		1673
1361	sub _wait {	1674	sub _wait {
		1675	$WAITING
		1676	and !$_[0]{_ae_sent}
		1677	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1678
		1679	local $WAITING = 1;
1362	AnyEvent->one_event while !$_[0]{_ae_sent};	1680	AnyEvent->one_event while !$_[0]{_ae_sent};
1363	}	1681	}
1364		1682
1365	sub recv {	1683	sub recv {
1366	$_[0]->_wait;	1684	$_[0]->_wait;
…		…
1368	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1686	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1369	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1687	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1370	}	1688	}
1371		1689
1372	sub cb {	1690	sub cb {
1373	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1691	my $cv = shift;
		1692
		1693	@_
		1694	and $cv->{_ae_cb} = shift
		1695	and $cv->{_ae_sent}
		1696	and (delete $cv->{_ae_cb})->($cv);
		1697
1374	$_[0]{_ae_cb}	1698	$cv->{_ae_cb}
1375	}	1699	}
1376		1700
1377	sub begin {	1701	sub begin {
1378	++$_[0]{_ae_counter};	1702	++$_[0]{_ae_counter};
1379	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1703	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1428	C<PERL_ANYEVENT_MODEL>.	1752	C<PERL_ANYEVENT_MODEL>.
1429		1753
1430	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1754	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1431	model it chooses.	1755	model it chooses.
1432		1756
		1757	When set to C<8> or higher, then AnyEvent will report extra information on
		1758	which optional modules it loads and how it implements certain features.
		1759
1433	=item C<PERL_ANYEVENT_STRICT>	1760	=item C<PERL_ANYEVENT_STRICT>
1434		1761
1435	AnyEvent does not do much argument checking by default, as thorough	1762	AnyEvent does not do much argument checking by default, as thorough
1436	argument checking is very costly. Setting this variable to a true value	1763	argument checking is very costly. Setting this variable to a true value
1437	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1764	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1438	check the arguments passed to most method calls. If it finds any problems,	1765	check the arguments passed to most method calls. If it finds any problems,
1439	it will croak.	1766	it will croak.
1440		1767
1441	In other words, enables "strict" mode.	1768	In other words, enables "strict" mode.
1442		1769
1443	Unlike C<use strict>, it is definitely recommended to keep it off in	1770	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1444	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1771	>>, it is definitely recommended to keep it off in production. Keeping
1445	developing programs can be very useful, however.	1772	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1773	can be very useful, however.
1446		1774
1447	=item C<PERL_ANYEVENT_MODEL>	1775	=item C<PERL_ANYEVENT_MODEL>
1448		1776
1449	This can be used to specify the event model to be used by AnyEvent, before	1777	This can be used to specify the event model to be used by AnyEvent, before
1450	auto detection and -probing kicks in. It must be a string consisting	1778	auto detection and -probing kicks in. It must be a string consisting
…		…
1512		1840
1513	When neither C<ca_file> nor C<ca_path> was specified during	1841	When neither C<ca_file> nor C<ca_path> was specified during
1514	L<AnyEvent::TLS> context creation, and either of these environment	1842	L<AnyEvent::TLS> context creation, and either of these environment
1515	variables exist, they will be used to specify CA certificate locations	1843	variables exist, they will be used to specify CA certificate locations
1516	instead of a system-dependent default.	1844	instead of a system-dependent default.
		1845
		1846	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1847
		1848	When these are set to C<1>, then the respective modules are not
		1849	loaded. Mostly good for testing AnyEvent itself.
1517		1850
1518	=back	1851	=back
1519		1852
1520	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1853	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1521		1854
…		…
1729	through AnyEvent. The benchmark creates a lot of timers (with a zero	2062	through AnyEvent. The benchmark creates a lot of timers (with a zero
1730	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2063	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1731	which it is), lets them fire exactly once and destroys them again.	2064	which it is), lets them fire exactly once and destroys them again.
1732		2065
1733	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2066	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1734	distribution.	2067	distribution. It uses the L<AE> interface, which makes a real difference
		2068	for the EV and Perl backends only.
1735		2069
1736	=head3 Explanation of the columns	2070	=head3 Explanation of the columns
1737		2071
1738	I<watcher> is the number of event watchers created/destroyed. Since	2072	I<watcher> is the number of event watchers created/destroyed. Since
1739	different event models feature vastly different performances, each event	2073	different event models feature vastly different performances, each event
…		…
1760	watcher.	2094	watcher.
1761		2095
1762	=head3 Results	2096	=head3 Results
1763		2097
1764	name watchers bytes create invoke destroy comment	2098	name watchers bytes create invoke destroy comment
1765	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2099	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1766	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2100	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1767	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2101	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1768	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2102	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1769	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2103	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1770	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2104	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1771	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2105	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1772	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2106	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1773	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2107	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1774	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2108	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1775	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2109	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1776	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2110	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1777		2111
1778	=head3 Discussion	2112	=head3 Discussion
1779		2113
1780	The benchmark does I<not> measure scalability of the event loop very	2114	The benchmark does I<not> measure scalability of the event loop very
1781	well. For example, a select-based event loop (such as the pure perl one)	2115	well. For example, a select-based event loop (such as the pure perl one)
…		…
1793	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2127	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1794	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2128	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1795	cycles with POE.	2129	cycles with POE.
1796		2130
1797	C<EV> is the sole leader regarding speed and memory use, which are both	2131	C<EV> is the sole leader regarding speed and memory use, which are both
1798	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2132	maximal/minimal, respectively. When using the L<AE> API there is zero
		2133	overhead (when going through the AnyEvent API create is about 5-6 times
		2134	slower, with other times being equal, so still uses far less memory than
1799	far less memory than any other event loop and is still faster than Event	2135	any other event loop and is still faster than Event natively).
1800	natively.
1801		2136
1802	The pure perl implementation is hit in a few sweet spots (both the	2137	The pure perl implementation is hit in a few sweet spots (both the
1803	constant timeout and the use of a single fd hit optimisations in the perl	2138	constant timeout and the use of a single fd hit optimisations in the perl
1804	interpreter and the backend itself). Nevertheless this shows that it	2139	interpreter and the backend itself). Nevertheless this shows that it
1805	adds very little overhead in itself. Like any select-based backend its	2140	adds very little overhead in itself. Like any select-based backend its
…		…
1879	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2214	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1880	(1%) are active. This mirrors the activity of large servers with many	2215	(1%) are active. This mirrors the activity of large servers with many
1881	connections, most of which are idle at any one point in time.	2216	connections, most of which are idle at any one point in time.
1882		2217
1883	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2218	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1884	distribution.	2219	distribution. It uses the L<AE> interface, which makes a real difference
		2220	for the EV and Perl backends only.
1885		2221
1886	=head3 Explanation of the columns	2222	=head3 Explanation of the columns
1887		2223
1888	I<sockets> is the number of sockets, and twice the number of "servers" (as	2224	I<sockets> is the number of sockets, and twice the number of "servers" (as
1889	each server has a read and write socket end).	2225	each server has a read and write socket end).
…		…
1897	a new one that moves the timeout into the future.	2233	a new one that moves the timeout into the future.
1898		2234
1899	=head3 Results	2235	=head3 Results
1900		2236
1901	name sockets create request	2237	name sockets create request
1902	EV 20000 69.01 11.16	2238	EV 20000 62.66 7.99
1903	Perl 20000 73.32 35.87	2239	Perl 20000 68.32 32.64
1904	IOAsync 20000 157.00 98.14 epoll	2240	IOAsync 20000 174.06 101.15 epoll
1905	IOAsync 20000 159.31 616.06 poll	2241	IOAsync 20000 174.67 610.84 poll
1906	Event 20000 212.62 257.32	2242	Event 20000 202.69 242.91
1907	Glib 20000 651.16 1896.30	2243	Glib 20000 557.01 1689.52
1908	POE 20000 349.67 12317.24 uses POE::Loop::Event	2244	POE 20000 341.54 12086.32 uses POE::Loop::Event
1909		2245
1910	=head3 Discussion	2246	=head3 Discussion
1911		2247
1912	This benchmark I<does> measure scalability and overall performance of the	2248	This benchmark I<does> measure scalability and overall performance of the
1913	particular event loop.	2249	particular event loop.
…		…
2060		2396
2061	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2397	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2062	emulation for event loops that do not support them natively. Also, some	2398	emulation for event loops that do not support them natively. Also, some
2063	event loops install a similar handler.	2399	event loops install a similar handler.
2064		2400
2065	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will	2401	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2066	reset it to default, to avoid losing child exit statuses.	2402	AnyEvent will reset it to default, to avoid losing child exit statuses.
2067		2403
2068	=item SIGPIPE	2404	=item SIGPIPE
2069		2405
2070	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2406	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2071	when AnyEvent gets loaded.	2407	when AnyEvent gets loaded.
…		…
2089	if $SIG{CHLD} eq 'IGNORE';	2425	if $SIG{CHLD} eq 'IGNORE';
2090		2426
2091	$SIG{PIPE} = sub { }	2427	$SIG{PIPE} = sub { }
2092	unless defined $SIG{PIPE};	2428	unless defined $SIG{PIPE};
2093		2429
		2430	=head1 RECOMMENDED/OPTIONAL MODULES
		2431
		2432	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2433	it's built-in modules) are required to use it.
		2434
		2435	That does not mean that AnyEvent won't take advantage of some additional
		2436	modules if they are installed.
		2437
		2438	This section epxlains which additional modules will be used, and how they
		2439	affect AnyEvent's operetion.
		2440
		2441	=over 4
		2442
		2443	=item L<Async::Interrupt>
		2444
		2445	This slightly arcane module is used to implement fast signal handling: To
		2446	my knowledge, there is no way to do completely race-free and quick
		2447	signal handling in pure perl. To ensure that signals still get
		2448	delivered, AnyEvent will start an interval timer to wake up perl (and
		2449	catch the signals) with some delay (default is 10 seconds, look for
		2450	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2451
		2452	If this module is available, then it will be used to implement signal
		2453	catching, which means that signals will not be delayed, and the event loop
		2454	will not be interrupted regularly, which is more efficient (And good for
		2455	battery life on laptops).
		2456
		2457	This affects not just the pure-perl event loop, but also other event loops
		2458	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2459
		2460	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2461	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2462	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2463	does nothing for those backends.
		2464
		2465	=item L<EV>
		2466
		2467	This module isn't really "optional", as it is simply one of the backend
		2468	event loops that AnyEvent can use. However, it is simply the best event
		2469	loop available in terms of features, speed and stability: It supports
		2470	the AnyEvent API optimally, implements all the watcher types in XS, does
		2471	automatic timer adjustments even when no monotonic clock is available,
		2472	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2473	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2474	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2475
		2476	=item L<Guard>
		2477
		2478	The guard module, when used, will be used to implement
		2479	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2480	lot less memory), but otherwise doesn't affect guard operation much. It is
		2481	purely used for performance.
		2482
		2483	=item L<JSON> and L<JSON::XS>
		2484
		2485	This module is required when you want to read or write JSON data via
		2486	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2487	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2488
		2489	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2490	installed.
		2491
		2492	=item L<Net::SSLeay>
		2493
		2494	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2495	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2496	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2497
		2498	=item L<Time::HiRes>
		2499
		2500	This module is part of perl since release 5.008. It will be used when the
		2501	chosen event library does not come with a timing source on it's own. The
		2502	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2503	try to use a monotonic clock for timing stability.
		2504
		2505	=back
		2506
		2507
2094	=head1 FORK	2508	=head1 FORK
2095		2509
2096	Most event libraries are not fork-safe. The ones who are usually are	2510	Most event libraries are not fork-safe. The ones who are usually are
2097	because they rely on inefficient but fork-safe C<select> or C<poll>	2511	because they rely on inefficient but fork-safe C<select> or C<poll>
2098	calls. Only L<EV> is fully fork-aware.	2512	calls. Only L<EV> is fully fork-aware.
2099		2513
2100	If you have to fork, you must either do so I<before> creating your first	2514	If you have to fork, you must either do so I<before> creating your first
2101	watcher OR you must not use AnyEvent at all in the child.	2515	watcher OR you must not use AnyEvent at all in the child OR you must do
		2516	something completely out of the scope of AnyEvent.
2102		2517
2103		2518
2104	=head1 SECURITY CONSIDERATIONS	2519	=head1 SECURITY CONSIDERATIONS
2105		2520
2106	AnyEvent can be forced to load any event model via	2521	AnyEvent can be forced to load any event model via
…		…
2144	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2559	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2145		2560
2146	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2561	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2147	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2562	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2148	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2563	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2149	L<AnyEvent::Impl::POE>.	2564	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2150		2565
2151	Non-blocking file handles, sockets, TCP clients and	2566	Non-blocking file handles, sockets, TCP clients and
2152	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2567	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2153		2568
2154	Asynchronous DNS: L<AnyEvent::DNS>.	2569	Asynchronous DNS: L<AnyEvent::DNS>.
2155		2570
2156	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2571	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2572	L<Coro::Event>,
2157		2573
2158	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2574	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2575	L<AnyEvent::HTTP>.
2159		2576
2160		2577
2161	=head1 AUTHOR	2578	=head1 AUTHOR
2162		2579
2163	Marc Lehmann <schmorp@schmorp.de>	2580	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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