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.296 by root, Tue Nov 17 01:19:49 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
…		…
364	might affect timers and time-outs.	363	might affect timers and time-outs.
365		364
366	When this is the case, you can call this method, which will update the	365	When this is the case, you can call this method, which will update the
367	event loop's idea of "current time".	366	event loop's idea of "current time".
368		367
		368	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		369	when mod_perl executes the script, then the event loop will have the wrong
		370	idea about the "current time" (being potentially far in the past, when the
		371	script ran the last time). In that case you should arrange a call to C<<
		372	AnyEvent->now_update >> each time the web server process wakes up again
		373	(e.g. at the start of your script, or in a handler).
		374
369	Note that updating the time I<might> cause some events to be handled.	375	Note that updating the time I<might> cause some events to be handled.
370		376
371	=back	377	=back
372		378
373	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
		380
		381	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
374		382
375	You can watch for signals using a signal watcher, C<signal> is the signal	383	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	384	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
377	callback to be invoked whenever a signal occurs.	385	callback to be invoked whenever a signal occurs.
378		386
…		…
384	invocation, and callback invocation will be synchronous. Synchronous means	392	invocation, and callback invocation will be synchronous. Synchronous means
385	that it might take a while until the signal gets handled by the process,	393	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.	394	but it is guaranteed not to interrupt any other callbacks.
387		395
388	The main advantage of using these watchers is that you can share a signal	396	The main advantage of using these watchers is that you can share a signal
389	between multiple watchers.	397	between multiple watchers, and AnyEvent will ensure that signals will not
		398	interrupt your program at bad times.
390		399
391	This watcher might use C<%SIG>, so programs overwriting those signals	400	This watcher might use C<%SIG> (depending on the event loop used),
392	directly will likely not work correctly.	401	so programs overwriting those signals directly will likely not work
		402	correctly.
393		403
394	Example: exit on SIGINT	404	Example: exit on SIGINT
395		405
396	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
397		407
		408	=head3 Signal Races, Delays and Workarounds
		409
		410	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		411	callbacks to signals in a generic way, which is a pity, as you cannot
		412	do race-free signal handling in perl, requiring C libraries for
		413	this. AnyEvent will try to do it's best, which means in some cases,
		414	signals will be delayed. The maximum time a signal might be delayed is
		415	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		416	variable can be changed only before the first signal watcher is created,
		417	and should be left alone otherwise. This variable determines how often
		418	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		419	will cause fewer spurious wake-ups, which is better for power and CPU
		420	saving.
		421
		422	All these problems can be avoided by installing the optional
		423	L<Async::Interrupt> module, which works with most event loops. It will not
		424	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		425	(and not with L<POE> currently, as POE does it's own workaround with
		426	one-second latency). For those, you just have to suffer the delays.
		427
398	=head2 CHILD PROCESS WATCHERS	428	=head2 CHILD PROCESS WATCHERS
399		429
		430	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		431
400	You can also watch on a child process exit and catch its exit status.	432	You can also watch on a child process exit and catch its exit status.
401		433
402	The child process is specified by the C<pid> argument (if set to C<0>, it	434	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	435	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	436	croak). The watcher will be triggered only when the child process has
405	any trace events (stopped/continued).	437	finished and an exit status is available, not on any trace events
		438	(stopped/continued).
406		439
407	The callback will be called with the pid and exit status (as returned by	440	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	441	waitpid), so unlike other watcher types, you I<can> rely on child watcher
409	callback arguments.	442	callback arguments.
410		443
…		…
426		459
427	This means you cannot create a child watcher as the very first	460	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	461	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	462	watcher before you C<fork> the child (alternatively, you can call
430	C<AnyEvent::detect>).	463	C<AnyEvent::detect>).
		464
		465	As most event loops do not support waiting for child events, they will be
		466	emulated by AnyEvent in most cases, in which the latency and race problems
		467	mentioned in the description of signal watchers apply.
431		468
432	Example: fork a process and wait for it	469	Example: fork a process and wait for it
433		470
434	my $done = AnyEvent->condvar;	471	my $done = AnyEvent->condvar;
435		472
…		…
447	# do something else, then wait for process exit	484	# do something else, then wait for process exit
448	$done->recv;	485	$done->recv;
449		486
450	=head2 IDLE WATCHERS	487	=head2 IDLE WATCHERS
451		488
		489	$w = AnyEvent->idle (cb => <callback>);
		490
452	Sometimes there is a need to do something, but it is not so important	491	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	492	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	493	"nothing better to do" is usually defined to be "no other events need
455	attention by the event loop".	494	attention by the event loop".
456		495
…		…
482	});	521	});
483	});	522	});
484		523
485	=head2 CONDITION VARIABLES	524	=head2 CONDITION VARIABLES
486		525
		526	$cv = AnyEvent->condvar;
		527
		528	$cv->send (<list>);
		529	my @res = $cv->recv;
		530
487	If you are familiar with some event loops you will know that all of them	531	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	532	require you to run some blocking "loop", "run" or similar function that
489	will actively watch for new events and call your callbacks.	533	will actively watch for new events and call your callbacks.
490		534
491	AnyEvent is different, it expects somebody else to run the event loop and	535	AnyEvent is slightly different: it expects somebody else to run the event
492	will only block when necessary (usually when told by the user).	536	loop and will only block when necessary (usually when told by the user).
493		537
494	The instrument to do that is called a "condition variable", so called	538	The instrument to do that is called a "condition variable", so called
495	because they represent a condition that must become true.	539	because they represent a condition that must become true.
496		540
		541	Now is probably a good time to look at the examples further below.
		542
497	Condition variables can be created by calling the C<< AnyEvent->condvar	543	Condition variables can be created by calling the C<< AnyEvent->condvar
498	>> method, usually without arguments. The only argument pair allowed is	544	>> 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	545	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	546	becomes true, with the condition variable as the first argument (but not
502	the results).	547	the results).
503		548
504	After creation, the condition variable is "false" until it becomes "true"	549	After creation, the condition variable is "false" until it becomes "true"
…		…
509	Condition variables are similar to callbacks, except that you can	554	Condition variables are similar to callbacks, except that you can
510	optionally wait for them. They can also be called merge points - points	555	optionally wait for them. They can also be called merge points - points
511	in time where multiple outstanding events have been processed. And yet	556	in time where multiple outstanding events have been processed. And yet
512	another way to call them is transactions - each condition variable can be	557	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	558	used to represent a transaction, which finishes at some point and delivers
514	a result.	559	a result. And yet some people know them as "futures" - a promise to
		560	compute/deliver something that you can wait for.
515		561
516	Condition variables are very useful to signal that something has finished,	562	Condition variables are very useful to signal that something has finished,
517	for example, if you write a module that does asynchronous http requests,	563	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	564	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	565	availability of results. The user can either act when the callback is
…		…
553	after => 1,	599	after => 1,
554	cb => sub { $result_ready->send },	600	cb => sub { $result_ready->send },
555	);	601	);
556		602
557	# this "blocks" (while handling events) till the callback	603	# this "blocks" (while handling events) till the callback
558	# calls send	604	# calls ->send
559	$result_ready->recv;	605	$result_ready->recv;
560		606
561	Example: wait for a timer, but take advantage of the fact that	607	Example: wait for a timer, but take advantage of the fact that condition
562	condition variables are also code references.	608	variables are also callable directly.
563		609
564	my $done = AnyEvent->condvar;	610	my $done = AnyEvent->condvar;
565	my $delay = AnyEvent->timer (after => 5, cb => $done);	611	my $delay = AnyEvent->timer (after => 5, cb => $done);
566	$done->recv;	612	$done->recv;
567		613
…		…
573		619
574	...	620	...
575		621
576	my @info = $couchdb->info->recv;	622	my @info = $couchdb->info->recv;
577		623
578	And this is how you would just ste a callback to be called whenever the	624	And this is how you would just set a callback to be called whenever the
579	results are available:	625	results are available:
580		626
581	$couchdb->info->cb (sub {	627	$couchdb->info->cb (sub {
582	my @info = $_[0]->recv;	628	my @info = $_[0]->recv;
583	});	629	});
…		…
601	immediately from within send.	647	immediately from within send.
602		648
603	Any arguments passed to the C<send> call will be returned by all	649	Any arguments passed to the C<send> call will be returned by all
604	future C<< ->recv >> calls.	650	future C<< ->recv >> calls.
605		651
606	Condition variables are overloaded so one can call them directly	652	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	653	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	654	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		655
615	=item $cv->croak ($error)	656	=item $cv->croak ($error)
616		657
617	Similar to send, but causes all call's to C<< ->recv >> to invoke	658	Similar to send, but causes all call's to C<< ->recv >> to invoke
618	C<Carp::croak> with the given error message/object/scalar.	659	C<Carp::croak> with the given error message/object/scalar.
619		660
620	This can be used to signal any errors to the condition variable	661	This can be used to signal any errors to the condition variable
621	user/consumer.	662	user/consumer. Doing it this way instead of calling C<croak> directly
		663	delays the error detetcion, but has the overwhelmign advantage that it
		664	diagnoses the error at the place where the result is expected, and not
		665	deep in some event clalback without connection to the actual code causing
		666	the problem.
622		667
623	=item $cv->begin ([group callback])	668	=item $cv->begin ([group callback])
624		669
625	=item $cv->end	670	=item $cv->end
626		671
…		…
628	one. For example, a function that pings many hosts in parallel might want	673	one. For example, a function that pings many hosts in parallel might want
629	to use a condition variable for the whole process.	674	to use a condition variable for the whole process.
630		675
631	Every call to C<< ->begin >> will increment a counter, and every call to	676	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	677	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	678	>>, 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	679	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.	680	>>, but that is not required. If no group callback was set, C<send> will
		681	be called without any arguments.
636		682
637	You can think of C<< $cv->send >> giving you an OR condition (one call	683	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	684	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).	685	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
640		686
…		…
667	begung can potentially be zero:	713	begung can potentially be zero:
668		714
669	my $cv = AnyEvent->condvar;	715	my $cv = AnyEvent->condvar;
670		716
671	my %result;	717	my %result;
672	$cv->begin (sub { $cv->send (\%result) });	718	$cv->begin (sub { shift->send (\%result) });
673		719
674	for my $host (@list_of_hosts) {	720	for my $host (@list_of_hosts) {
675	$cv->begin;	721	$cv->begin;
676	ping_host_then_call_callback $host, sub {	722	ping_host_then_call_callback $host, sub {
677	$result{$host} = ...;	723	$result{$host} = ...;
…		…
722	function will call C<croak>.	768	function will call C<croak>.
723		769
724	In list context, all parameters passed to C<send> will be returned,	770	In list context, all parameters passed to C<send> will be returned,
725	in scalar context only the first one will be returned.	771	in scalar context only the first one will be returned.
726		772
		773	Note that doing a blocking wait in a callback is not supported by any
		774	event loop, that is, recursive invocation of a blocking C<< ->recv
		775	>> is not allowed, and the C<recv> call will C<croak> if such a
		776	condition is detected. This condition can be slightly loosened by using
		777	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		778	any thread that doesn't run the event loop itself.
		779
727	Not all event models support a blocking wait - some die in that case	780	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	781	(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	782	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	783	caller decide whether the call will block or not (for example, by coupling
731	condition variables with some kind of request results and supporting	784	condition variables with some kind of request results and supporting
732	callbacks so the caller knows that getting the result will not block,	785	callbacks so the caller knows that getting the result will not block,
733	while still supporting blocking waits if the caller so desires).	786	while still supporting blocking waits if the caller so desires).
734		787
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	788	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	789	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	790	time). This will work even when the event loop does not support blocking
749	waits otherwise.	791	waits otherwise.
750		792
…		…
756	=item $cb = $cv->cb ($cb->($cv))	798	=item $cb = $cv->cb ($cb->($cv))
757		799
758	This is a mutator function that returns the callback set and optionally	800	This is a mutator function that returns the callback set and optionally
759	replaces it before doing so.	801	replaces it before doing so.
760		802
761	The callback will be called when the condition becomes "true", i.e. when	803	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	804	"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	805	the only argument being the condition variable itself. Calling C<recv>
764	is guaranteed not to block.	806	inside the callback or at any later time is guaranteed not to block.
765		807
766	=back	808	=back
767		809
		810	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		811
		812	The available backend classes are (every class has its own manpage):
		813
		814	=over 4
		815
		816	=item Backends that are autoprobed when no other event loop can be found.
		817
		818	EV is the preferred backend when no other event loop seems to be in
		819	use. If EV is not installed, then AnyEvent will fall back to its own
		820	pure-perl implementation, which is available everywhere as it comes with
		821	AnyEvent itself.
		822
		823	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		824	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		825
		826	=item Backends that are transparently being picked up when they are used.
		827
		828	These will be used when they are currently loaded when the first watcher
		829	is created, in which case it is assumed that the application is using
		830	them. This means that AnyEvent will automatically pick the right backend
		831	when the main program loads an event module before anything starts to
		832	create watchers. Nothing special needs to be done by the main program.
		833
		834	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		835	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		836	AnyEvent::Impl::Tk based on Tk, very broken.
		837	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		838	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		839	AnyEvent::Impl::Irssi used when running within irssi.
		840
		841	=item Backends with special needs.
		842
		843	Qt requires the Qt::Application to be instantiated first, but will
		844	otherwise be picked up automatically. As long as the main program
		845	instantiates the application before any AnyEvent watchers are created,
		846	everything should just work.
		847
		848	AnyEvent::Impl::Qt based on Qt.
		849
		850	Support for IO::Async can only be partial, as it is too broken and
		851	architecturally limited to even support the AnyEvent API. It also
		852	is the only event loop that needs the loop to be set explicitly, so
		853	it can only be used by a main program knowing about AnyEvent. See
		854	L<AnyEvent::Impl::Async> for the gory details.
		855
		856	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		857
		858	=item Event loops that are indirectly supported via other backends.
		859
		860	Some event loops can be supported via other modules:
		861
		862	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		863
		864	B<WxWidgets> has no support for watching file handles. However, you can
		865	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		866	polls 20 times per second, which was considered to be too horrible to even
		867	consider for AnyEvent.
		868
		869	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		870	backend, so it can be supported through POE.
		871
		872	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		873	load L<POE> when detecting them, in the hope that POE will pick them up,
		874	in which case everything will be automatic.
		875
		876	=back
		877
768	=head1 GLOBAL VARIABLES AND FUNCTIONS	878	=head1 GLOBAL VARIABLES AND FUNCTIONS
769		879
		880	These are not normally required to use AnyEvent, but can be useful to
		881	write AnyEvent extension modules.
		882
770	=over 4	883	=over 4
771		884
772	=item $AnyEvent::MODEL	885	=item $AnyEvent::MODEL
773		886
774	Contains C<undef> until the first watcher is being created. Then it	887	Contains C<undef> until the first watcher is being created, before the
		888	backend has been autodetected.
		889
775	contains the event model that is being used, which is the name of the	890	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	891	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	892	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>).	893	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
779		894	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		895
805	=item AnyEvent::detect	896	=item AnyEvent::detect
806		897
807	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	898	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
808	if necessary. You should only call this function right before you would	899	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	900	have created an AnyEvent watcher anyway, that is, as late as possible at
810	runtime.	901	runtime, and not e.g. while initialising of your module.
		902
		903	If you need to do some initialisation before AnyEvent watchers are
		904	created, use C<post_detect>.
811		905
812	=item $guard = AnyEvent::post_detect { BLOCK }	906	=item $guard = AnyEvent::post_detect { BLOCK }
813		907
814	Arranges for the code block to be executed as soon as the event model is	908	Arranges for the code block to be executed as soon as the event model is
815	autodetected (or immediately if this has already happened).	909	autodetected (or immediately if this has already happened).
816		910
		911	The block will be executed I<after> the actual backend has been detected
		912	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		913	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		914	other initialisations - see the sources of L<AnyEvent::Strict> or
		915	L<AnyEvent::AIO> to see how this is used.
		916
		917	The most common usage is to create some global watchers, without forcing
		918	event module detection too early, for example, L<AnyEvent::AIO> creates
		919	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		920	avoid autodetecting the event module at load time.
		921
817	If called in scalar or list context, then it creates and returns an object	922	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	923	that automatically removes the callback again when it is destroyed (or
		924	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
819	L<Coro::BDB> for a case where this is useful.	925	a case where this is useful.
		926
		927	Example: Create a watcher for the IO::AIO module and store it in
		928	C<$WATCHER>. Only do so after the event loop is initialised, though.
		929
		930	our WATCHER;
		931
		932	my $guard = AnyEvent::post_detect {
		933	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		934	};
		935
		936	# the ||= is important in case post_detect immediately runs the block,
		937	# as to not clobber the newly-created watcher. assigning both watcher and
		938	# post_detect guard to the same variable has the advantage of users being
		939	# able to just C<undef $WATCHER> if the watcher causes them grief.
		940
		941	$WATCHER ||= $guard;
820		942
821	=item @AnyEvent::post_detect	943	=item @AnyEvent::post_detect
822		944
823	If there are any code references in this array (you can C<push> to it	945	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	946	before or after loading AnyEvent), then they will called directly after
825	the event loop has been chosen.	947	the event loop has been chosen.
826		948
827	You should check C<$AnyEvent::MODEL> before adding to this array, though:	949	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,	950	if it is defined then the event loop has already been detected, and the
829	and the array will be ignored.	951	array will be ignored.
830		952
831	Best use C<AnyEvent::post_detect { BLOCK }> instead.	953	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		954	it,as it takes care of these details.
		955
		956	This variable is mainly useful for modules that can do something useful
		957	when AnyEvent is used and thus want to know when it is initialised, but do
		958	not need to even load it by default. This array provides the means to hook
		959	into AnyEvent passively, without loading it.
832		960
833	=back	961	=back
834		962
835	=head1 WHAT TO DO IN A MODULE	963	=head1 WHAT TO DO IN A MODULE
836		964
…		…
891		1019
892		1020
893	=head1 OTHER MODULES	1021	=head1 OTHER MODULES
894		1022
895	The following is a non-exhaustive list of additional modules that use	1023	The following is a non-exhaustive list of additional modules that use
896	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1024	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	1025	modules and other event loops in the same program. Some of the modules
898	available via CPAN.	1026	come with AnyEvent, most are available via CPAN.
899		1027
900	=over 4	1028	=over 4
901		1029
902	=item L<AnyEvent::Util>	1030	=item L<AnyEvent::Util>
903		1031
…		…
912		1040
913	=item L<AnyEvent::Handle>	1041	=item L<AnyEvent::Handle>
914		1042
915	Provide read and write buffers, manages watchers for reads and writes,	1043	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	1044	supports raw and formatted I/O, I/O queued and fully transparent and
917	non-blocking SSL/TLS.	1045	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
918		1046
919	=item L<AnyEvent::DNS>	1047	=item L<AnyEvent::DNS>
920		1048
921	Provides rich asynchronous DNS resolver capabilities.	1049	Provides rich asynchronous DNS resolver capabilities.
922		1050
…		…
950		1078
951	=item L<AnyEvent::GPSD>	1079	=item L<AnyEvent::GPSD>
952		1080
953	A non-blocking interface to gpsd, a daemon delivering GPS information.	1081	A non-blocking interface to gpsd, a daemon delivering GPS information.
954		1082
		1083	=item L<AnyEvent::IRC>
		1084
		1085	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1086
		1087	=item L<AnyEvent::XMPP>
		1088
		1089	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1090	Net::XMPP2>.
		1091
955	=item L<AnyEvent::IGS>	1092	=item L<AnyEvent::IGS>
956		1093
957	A non-blocking interface to the Internet Go Server protocol (used by	1094	A non-blocking interface to the Internet Go Server protocol (used by
958	L<App::IGS>).	1095	L<App::IGS>).
959		1096
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>	1097	=item L<Net::FCP>
969		1098
970	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1099	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
971	of AnyEvent.	1100	of AnyEvent.
972		1101
…		…
976		1105
977	=item L<Coro>	1106	=item L<Coro>
978		1107
979	Has special support for AnyEvent via L<Coro::AnyEvent>.	1108	Has special support for AnyEvent via L<Coro::AnyEvent>.
980		1109
981	=item L<IO::Lambda>
982
983	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
984
985	=back	1110	=back
986		1111
987	=cut	1112	=cut
988		1113
989	package AnyEvent;	1114	package AnyEvent;
990		1115
991	no warnings;	1116	# basically a tuned-down version of common::sense
		1117	sub common_sense {
		1118	# from common:.sense 1.0
		1119	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
992	use strict qw(vars subs);	1120	# use strict vars subs
		1121	$^H |= 0x00000600;
		1122	}
993		1123
		1124	BEGIN { AnyEvent::common_sense }
		1125
994	use Carp;	1126	use Carp ();
995		1127
996	our $VERSION = 4.8;	1128	our $VERSION = '5.202';
997	our $MODEL;	1129	our $MODEL;
998		1130
999	our $AUTOLOAD;	1131	our $AUTOLOAD;
1000	our @ISA;	1132	our @ISA;
1001		1133
1002	our @REGISTRY;	1134	our @REGISTRY;
1003		1135
1004	our $WIN32;	1136	our $WIN32;
		1137
		1138	our $VERBOSE;
1005		1139
1006	BEGIN {	1140	BEGIN {
1007	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1141	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1008	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1142	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1009		1143
1010	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1144	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1011	if ${^TAINT};	1145	if ${^TAINT};
1012	}
1013		1146
1014	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1147	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1148
		1149	}
		1150
		1151	our $MAX_SIGNAL_LATENCY = 10;
1015		1152
1016	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1153	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1017		1154
1018	{	1155	{
1019	my $idx;	1156	my $idx;
…		…
1021	for reverse split /\s*,\s*/,	1158	for reverse split /\s*,\s*/,
1022	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1159	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1023	}	1160	}
1024		1161
1025	my @models = (	1162	my @models = (
1026	[EV:: => AnyEvent::Impl::EV::],	1163	[EV:: => AnyEvent::Impl::EV:: , 1],
1027	[Event:: => AnyEvent::Impl::Event::],
1028	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1164	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1029	# everything below here will not be autoprobed	1165	# everything below here will not (normally) be autoprobed
1030	# as the pureperl backend should work everywhere	1166	# as the pureperl backend should work everywhere
1031	# and is usually faster	1167	# and is usually faster
		1168	[Event:: => AnyEvent::Impl::Event::, 1],
		1169	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1170	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1171	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1032	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1172	[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	1173	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1036	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1174	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1037	[Wx:: => AnyEvent::Impl::POE::],	1175	[Wx:: => AnyEvent::Impl::POE::],
1038	[Prima:: => AnyEvent::Impl::POE::],	1176	[Prima:: => AnyEvent::Impl::POE::],
1039	# IO::Async is just too broken - we would need workaorunds for its	1177	# IO::Async is just too broken - we would need workarounds for its
1040	# byzantine signal and broken child handling, among others.	1178	# byzantine signal and broken child handling, among others.
1041	# IO::Async is rather hard to detect, as it doesn't have any	1179	# IO::Async is rather hard to detect, as it doesn't have any
1042	# obvious default class.	1180	# obvious default class.
1043	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1181	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1044	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1182	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1045	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1183	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1184	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1046	);	1185	);
1047		1186
1048	our %method = map +($_ => 1),	1187	our %method = map +($_ => 1),
1049	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1188	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1050		1189
…		…
1054	my ($cb) = @_;	1193	my ($cb) = @_;
1055		1194
1056	if ($MODEL) {	1195	if ($MODEL) {
1057	$cb->();	1196	$cb->();
1058		1197
1059	1	1198	undef
1060	} else {	1199	} else {
1061	push @post_detect, $cb;	1200	push @post_detect, $cb;
1062		1201
1063	defined wantarray	1202	defined wantarray
1064	? bless \$cb, "AnyEvent::Util::postdetect"	1203	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1070	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1209	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1071	}	1210	}
1072		1211
1073	sub detect() {	1212	sub detect() {
1074	unless ($MODEL) {	1213	unless ($MODEL) {
1075	no strict 'refs';
1076	local $SIG{__DIE__};	1214	local $SIG{__DIE__};
1077		1215
1078	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1216	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1079	my $model = "AnyEvent::Impl::$1";	1217	my $model = "AnyEvent::Impl::$1";
1080	if (eval "require $model") {	1218	if (eval "require $model") {
1081	$MODEL = $model;	1219	$MODEL = $model;
1082	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1220	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1083	} else {	1221	} else {
1084	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1222	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1085	}	1223	}
1086	}	1224	}
1087		1225
1088	# check for already loaded models	1226	# check for already loaded models
1089	unless ($MODEL) {	1227	unless ($MODEL) {
1090	for (@REGISTRY, @models) {	1228	for (@REGISTRY, @models) {
1091	my ($package, $model) = @$_;	1229	my ($package, $model) = @$_;
1092	if (${"$package\::VERSION"} > 0) {	1230	if (${"$package\::VERSION"} > 0) {
1093	if (eval "require $model") {	1231	if (eval "require $model") {
1094	$MODEL = $model;	1232	$MODEL = $model;
1095	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1233	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1096	last;	1234	last;
1097	}	1235	}
1098	}	1236	}
1099	}	1237	}
1100		1238
1101	unless ($MODEL) {	1239	unless ($MODEL) {
1102	# try to load a model	1240	# try to autoload a model
1103
1104	for (@REGISTRY, @models) {	1241	for (@REGISTRY, @models) {
1105	my ($package, $model) = @$_;	1242	my ($package, $model, $autoload) = @$_;
		1243	if (
		1244	$autoload
1106	if (eval "require $package"	1245	and eval "require $package"
1107	and ${"$package\::VERSION"} > 0	1246	and ${"$package\::VERSION"} > 0
1108	and eval "require $model") {	1247	and eval "require $model"
		1248	) {
1109	$MODEL = $model;	1249	$MODEL = $model;
1110	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1250	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1111	last;	1251	last;
1112	}	1252	}
1113	}	1253	}
1114		1254
1115	$MODEL	1255	$MODEL
…		…
1131		1271
1132	sub AUTOLOAD {	1272	sub AUTOLOAD {
1133	(my $func = $AUTOLOAD) =~ s/.*://;	1273	(my $func = $AUTOLOAD) =~ s/.*://;
1134		1274
1135	$method{$func}	1275	$method{$func}
1136	or croak "$func: not a valid method for AnyEvent objects";	1276	or Carp::croak "$func: not a valid method for AnyEvent objects";
1137		1277
1138	detect unless $MODEL;	1278	detect unless $MODEL;
1139		1279
1140	my $class = shift;	1280	my $class = shift;
1141	$class->$func (@_);	1281	$class->$func (@_);
…		…
1146	# allow only one watcher per fd, so we dup it to get a different one).	1286	# allow only one watcher per fd, so we dup it to get a different one).
1147	sub _dupfh($$;$$) {	1287	sub _dupfh($$;$$) {
1148	my ($poll, $fh, $r, $w) = @_;	1288	my ($poll, $fh, $r, $w) = @_;
1149		1289
1150	# cygwin requires the fh mode to be matching, unix doesn't	1290	# cygwin requires the fh mode to be matching, unix doesn't
1151	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1291	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		1292
1155	open my $fh2, "$mode&" . fileno $fh	1293	open my $fh2, $mode, $fh
1156	or die "cannot dup() filehandle: $!,";	1294	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1157		1295
1158	# we assume CLOEXEC is already set by perl in all important cases	1296	# we assume CLOEXEC is already set by perl in all important cases
1159		1297
1160	($fh2, $rw)	1298	($fh2, $rw)
1161	}	1299	}
1162		1300
		1301	=head1 SIMPLIFIED AE API
		1302
		1303	Starting with version 5.0, AnyEvent officially supports a second, much
		1304	simpler, API that is designed to reduce the calling, typing and memory
		1305	overhead.
		1306
		1307	See the L<AE> manpage for details.
		1308
		1309	=cut
		1310
		1311	package AE;
		1312
		1313	our $VERSION = $AnyEvent::VERSION;
		1314
		1315	sub io($$$) {
		1316	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1317	}
		1318
		1319	sub timer($$$) {
		1320	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1321	}
		1322
		1323	sub signal($$) {
		1324	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1325	}
		1326
		1327	sub child($$) {
		1328	AnyEvent->child (pid => $_[0], cb => $_[1])
		1329	}
		1330
		1331	sub idle($) {
		1332	AnyEvent->idle (cb => $_[0])
		1333	}
		1334
		1335	sub cv(;&) {
		1336	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1337	}
		1338
		1339	sub now() {
		1340	AnyEvent->now
		1341	}
		1342
		1343	sub now_update() {
		1344	AnyEvent->now_update
		1345	}
		1346
		1347	sub time() {
		1348	AnyEvent->time
		1349	}
		1350
1163	package AnyEvent::Base;	1351	package AnyEvent::Base;
1164		1352
1165	# default implementations for many methods	1353	# default implementations for many methods
1166		1354
1167	BEGIN {	1355	sub _time() {
		1356	# probe for availability of Time::HiRes
1168	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1357	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1358	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1169	*_time = \&Time::HiRes::time;	1359	*_time = \&Time::HiRes::time;
1170	# if (eval "use POSIX (); (POSIX::times())...	1360	# if (eval "use POSIX (); (POSIX::times())...
1171	} else {	1361	} else {
		1362	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1172	*_time = sub { time }; # epic fail	1363	*_time = sub { time }; # epic fail
1173	}	1364	}
		1365
		1366	&_time
1174	}	1367	}
1175		1368
1176	sub time { _time }	1369	sub time { _time }
1177	sub now { _time }	1370	sub now { _time }
1178	sub now_update { }	1371	sub now_update { }
…		…
1183	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1376	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1184	}	1377	}
1185		1378
1186	# default implementation for ->signal	1379	# default implementation for ->signal
1187		1380
		1381	our $HAVE_ASYNC_INTERRUPT;
		1382
		1383	sub _have_async_interrupt() {
		1384	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1385	&& eval "use Async::Interrupt 1.02 (); 1")
		1386	unless defined $HAVE_ASYNC_INTERRUPT;
		1387
		1388	$HAVE_ASYNC_INTERRUPT
		1389	}
		1390
1188	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1391	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1392	our (%SIG_ASY, %SIG_ASY_W);
		1393	our ($SIG_COUNT, $SIG_TW);
1189		1394
1190	sub _signal_exec {	1395	sub _signal_exec {
		1396	$HAVE_ASYNC_INTERRUPT
		1397	? $SIGPIPE_R->drain
1191	sysread $SIGPIPE_R, my $dummy, 4;	1398	: sysread $SIGPIPE_R, (my $dummy), 9;
1192		1399
1193	while (%SIG_EV) {	1400	while (%SIG_EV) {
1194	for (keys %SIG_EV) {	1401	for (keys %SIG_EV) {
1195	delete $SIG_EV{$_};	1402	delete $SIG_EV{$_};
1196	$_->() for values %{ $SIG_CB{$_} || {} };	1403	$_->() for values %{ $SIG_CB{$_} || {} };
1197	}	1404	}
1198	}	1405	}
1199	}	1406	}
1200		1407
		1408	# install a dummy wakeup watcher to reduce signal catching latency
		1409	sub _sig_add() {
		1410	unless ($SIG_COUNT++) {
		1411	# try to align timer on a full-second boundary, if possible
		1412	my $NOW = AE::now;
		1413
		1414	$SIG_TW = AE::timer
		1415	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1416	$MAX_SIGNAL_LATENCY,
		1417	sub { } # just for the PERL_ASYNC_CHECK
		1418	;
		1419	}
		1420	}
		1421
		1422	sub _sig_del {
		1423	undef $SIG_TW
		1424	unless --$SIG_COUNT;
		1425	}
		1426
		1427	our $_sig_name_init; $_sig_name_init = sub {
		1428	eval q{ # poor man's autoloading
		1429	undef $_sig_name_init;
		1430
		1431	if (_have_async_interrupt) {
		1432	*sig2num = \&Async::Interrupt::sig2num;
		1433	*sig2name = \&Async::Interrupt::sig2name;
		1434	} else {
		1435	require Config;
		1436
		1437	my %signame2num;
		1438	@signame2num{ split ' ', $Config::Config{sig_name} }
		1439	= split ' ', $Config::Config{sig_num};
		1440
		1441	my @signum2name;
		1442	@signum2name[values %signame2num] = keys %signame2num;
		1443
		1444	*sig2num = sub($) {
		1445	$_[0] > 0 ? shift : $signame2num{+shift}
		1446	};
		1447	*sig2name = sub ($) {
		1448	$_[0] > 0 ? $signum2name[+shift] : shift
		1449	};
		1450	}
		1451	};
		1452	die if $@;
		1453	};
		1454
		1455	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1456	sub sig2name($) { &$_sig_name_init; &sig2name }
		1457
1201	sub signal {	1458	sub signal {
1202	my (undef, %arg) = @_;	1459	eval q{ # poor man's autoloading {}
		1460	# probe for availability of Async::Interrupt
		1461	if (_have_async_interrupt) {
		1462	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1203		1463
1204	unless ($SIGPIPE_R) {	1464	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1205	require Fcntl;	1465	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1206		1466
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 {	1467	} else {
		1468	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1469
		1470	require Fcntl;
		1471
		1472	if (AnyEvent::WIN32) {
		1473	require AnyEvent::Util;
		1474
		1475	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1476	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1477	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1478	} else {
1214	pipe $SIGPIPE_R, $SIGPIPE_W;	1479	pipe $SIGPIPE_R, $SIGPIPE_W;
1215	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1480	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	1481	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1217		1482
1218	# not strictly required, as $^F is normally 2, but let's make sure...	1483	# not strictly required, as $^F is normally 2, but let's make sure...
1219	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1484	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1220	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1485	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1486	}
		1487
		1488	$SIGPIPE_R
		1489	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1490
		1491	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1221	}	1492	}
1222		1493
1223	$SIGPIPE_R	1494	*signal = sub {
1224	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1495	my (undef, %arg) = @_;
1225		1496
1226	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1227	}
1228
1229	my $signal = uc $arg{signal}	1497	my $signal = uc $arg{signal}
1230	or Carp::croak "required option 'signal' is missing";	1498	or Carp::croak "required option 'signal' is missing";
1231		1499
		1500	if ($HAVE_ASYNC_INTERRUPT) {
		1501	# async::interrupt
		1502
		1503	$signal = sig2num $signal;
1232	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1504	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1505
		1506	$SIG_ASY{$signal} ||= new Async::Interrupt
		1507	cb => sub { undef $SIG_EV{$signal} },
		1508	signal => $signal,
		1509	pipe => [$SIGPIPE_R->filenos],
		1510	pipe_autodrain => 0,
		1511	;
		1512
		1513	} else {
		1514	# pure perl
		1515
		1516	# AE::Util has been loaded in signal
		1517	$signal = sig2name $signal;
		1518	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1519
1233	$SIG{$signal} ||= sub {	1520	$SIG{$signal} ||= sub {
1234	local $!;	1521	local $!;
1235	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1522	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1236	undef $SIG_EV{$signal};	1523	undef $SIG_EV{$signal};
		1524	};
		1525
		1526	# can't do signal processing without introducing races in pure perl,
		1527	# so limit the signal latency.
		1528	_sig_add;
		1529	}
		1530
		1531	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1532	};
		1533
		1534	*AnyEvent::Base::signal::DESTROY = sub {
		1535	my ($signal, $cb) = @{$_[0]};
		1536
		1537	_sig_del;
		1538
		1539	delete $SIG_CB{$signal}{$cb};
		1540
		1541	$HAVE_ASYNC_INTERRUPT
		1542	? delete $SIG_ASY{$signal}
		1543	: # delete doesn't work with older perls - they then
		1544	# print weird messages, or just unconditionally exit
		1545	# instead of getting the default action.
		1546	undef $SIG{$signal}
		1547	unless keys %{ $SIG_CB{$signal} };
		1548	};
1237	};	1549	};
1238		1550	die if $@;
1239	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1551	&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	}	1552	}
1252		1553
1253	# default implementation for ->child	1554	# default implementation for ->child
1254		1555
1255	our %PID_CB;	1556	our %PID_CB;
1256	our $CHLD_W;	1557	our $CHLD_W;
1257	our $CHLD_DELAY_W;	1558	our $CHLD_DELAY_W;
1258	our $WNOHANG;	1559	our $WNOHANG;
1259		1560
		1561	sub _emit_childstatus($$) {
		1562	my (undef, $rpid, $rstatus) = @_;
		1563
		1564	$_->($rpid, $rstatus)
		1565	for values %{ $PID_CB{$rpid} || {} },
		1566	values %{ $PID_CB{0} || {} };
		1567	}
		1568
1260	sub _sigchld {	1569	sub _sigchld {
		1570	my $pid;
		1571
		1572	AnyEvent->_emit_childstatus ($pid, $?)
1261	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1573	while ($pid = waitpid -1, $WNOHANG) > 0;
1262	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1263	(values %{ $PID_CB{0} || {} });
1264	}
1265	}	1574	}
1266		1575
1267	sub child {	1576	sub child {
1268	my (undef, %arg) = @_;	1577	my (undef, %arg) = @_;
1269		1578
1270	defined (my $pid = $arg{pid} + 0)	1579	defined (my $pid = $arg{pid} + 0)
1271	or Carp::croak "required option 'pid' is missing";	1580	or Carp::croak "required option 'pid' is missing";
1272		1581
1273	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1582	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1274		1583
		1584	# WNOHANG is almost cetrainly 1 everywhere
		1585	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
		1586	? 1
1275	$WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1587	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1276		1588
1277	unless ($CHLD_W) {	1589	unless ($CHLD_W) {
1278	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1590	$CHLD_W = AE::signal CHLD => \&_sigchld;
1279	# child could be a zombie already, so make at least one round	1591	# child could be a zombie already, so make at least one round
1280	&_sigchld;	1592	&_sigchld;
1281	}	1593	}
1282		1594
1283	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1595	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1309	# never use more then 50% of the time for the idle watcher,	1621	# never use more then 50% of the time for the idle watcher,
1310	# within some limits	1622	# within some limits
1311	$w = 0.0001 if $w < 0.0001;	1623	$w = 0.0001 if $w < 0.0001;
1312	$w = 5 if $w > 5;	1624	$w = 5 if $w > 5;
1313		1625
1314	$w = AnyEvent->timer (after => $w, cb => $rcb);	1626	$w = AE::timer $w, 0, $rcb;
1315	} else {	1627	} else {
1316	# clean up...	1628	# clean up...
1317	undef $w;	1629	undef $w;
1318	undef $rcb;	1630	undef $rcb;
1319	}	1631	}
1320	};	1632	};
1321		1633
1322	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1634	$w = AE::timer 0.05, 0, $rcb;
1323		1635
1324	bless \\$cb, "AnyEvent::Base::idle"	1636	bless \\$cb, "AnyEvent::Base::idle"
1325	}	1637	}
1326		1638
1327	sub AnyEvent::Base::idle::DESTROY {	1639	sub AnyEvent::Base::idle::DESTROY {
…		…
1332		1644
1333	our @ISA = AnyEvent::CondVar::Base::;	1645	our @ISA = AnyEvent::CondVar::Base::;
1334		1646
1335	package AnyEvent::CondVar::Base;	1647	package AnyEvent::CondVar::Base;
1336		1648
1337	use overload	1649	#use overload
1338	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1650	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1339	fallback => 1;	1651	# fallback => 1;
		1652
		1653	# save 300+ kilobytes by dirtily hardcoding overloading
		1654	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1655	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1656	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1657	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1658
		1659	our $WAITING;
1340		1660
1341	sub _send {	1661	sub _send {
1342	# nop	1662	# nop
1343	}	1663	}
1344		1664
…		…
1357	sub ready {	1677	sub ready {
1358	$_[0]{_ae_sent}	1678	$_[0]{_ae_sent}
1359	}	1679	}
1360		1680
1361	sub _wait {	1681	sub _wait {
		1682	$WAITING
		1683	and !$_[0]{_ae_sent}
		1684	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1685
		1686	local $WAITING = 1;
1362	AnyEvent->one_event while !$_[0]{_ae_sent};	1687	AnyEvent->one_event while !$_[0]{_ae_sent};
1363	}	1688	}
1364		1689
1365	sub recv {	1690	sub recv {
1366	$_[0]->_wait;	1691	$_[0]->_wait;
…		…
1368	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1693	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1369	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1694	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1370	}	1695	}
1371		1696
1372	sub cb {	1697	sub cb {
1373	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1698	my $cv = shift;
		1699
		1700	@_
		1701	and $cv->{_ae_cb} = shift
		1702	and $cv->{_ae_sent}
		1703	and (delete $cv->{_ae_cb})->($cv);
		1704
1374	$_[0]{_ae_cb}	1705	$cv->{_ae_cb}
1375	}	1706	}
1376		1707
1377	sub begin {	1708	sub begin {
1378	++$_[0]{_ae_counter};	1709	++$_[0]{_ae_counter};
1379	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1710	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1428	C<PERL_ANYEVENT_MODEL>.	1759	C<PERL_ANYEVENT_MODEL>.
1429		1760
1430	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1761	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1431	model it chooses.	1762	model it chooses.
1432		1763
		1764	When set to C<8> or higher, then AnyEvent will report extra information on
		1765	which optional modules it loads and how it implements certain features.
		1766
1433	=item C<PERL_ANYEVENT_STRICT>	1767	=item C<PERL_ANYEVENT_STRICT>
1434		1768
1435	AnyEvent does not do much argument checking by default, as thorough	1769	AnyEvent does not do much argument checking by default, as thorough
1436	argument checking is very costly. Setting this variable to a true value	1770	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	1771	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,	1772	check the arguments passed to most method calls. If it finds any problems,
1439	it will croak.	1773	it will croak.
1440		1774
1441	In other words, enables "strict" mode.	1775	In other words, enables "strict" mode.
1442		1776
1443	Unlike C<use strict>, it is definitely recommended to keep it off in	1777	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	1778	>>, it is definitely recommended to keep it off in production. Keeping
1445	developing programs can be very useful, however.	1779	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1780	can be very useful, however.
1446		1781
1447	=item C<PERL_ANYEVENT_MODEL>	1782	=item C<PERL_ANYEVENT_MODEL>
1448		1783
1449	This can be used to specify the event model to be used by AnyEvent, before	1784	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	1785	auto detection and -probing kicks in. It must be a string consisting
…		…
1512		1847
1513	When neither C<ca_file> nor C<ca_path> was specified during	1848	When neither C<ca_file> nor C<ca_path> was specified during
1514	L<AnyEvent::TLS> context creation, and either of these environment	1849	L<AnyEvent::TLS> context creation, and either of these environment
1515	variables exist, they will be used to specify CA certificate locations	1850	variables exist, they will be used to specify CA certificate locations
1516	instead of a system-dependent default.	1851	instead of a system-dependent default.
		1852
		1853	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1854
		1855	When these are set to C<1>, then the respective modules are not
		1856	loaded. Mostly good for testing AnyEvent itself.
1517		1857
1518	=back	1858	=back
1519		1859
1520	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1860	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1521		1861
…		…
1579	warn "read: $input\n"; # output what has been read	1919	warn "read: $input\n"; # output what has been read
1580	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1920	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1581	},	1921	},
1582	);	1922	);
1583		1923
1584	my $time_watcher; # can only be used once
1585
1586	sub new_timer {
1587	$timer = AnyEvent->timer (after => 1, cb => sub {	1924	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1588	warn "timeout\n"; # print 'timeout' about every second	1925	warn "timeout\n"; # print 'timeout' at most every second
1589	&new_timer; # and restart the time
1590	});	1926	});
1591	}
1592
1593	new_timer; # create first timer
1594		1927
1595	$cv->recv; # wait until user enters /^q/i	1928	$cv->recv; # wait until user enters /^q/i
1596		1929
1597	=head1 REAL-WORLD EXAMPLE	1930	=head1 REAL-WORLD EXAMPLE
1598		1931
…		…
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.
…		…
2039	As you can see, the AnyEvent + EV combination even beats the	2375	As you can see, the AnyEvent + EV combination even beats the
2040	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2376	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2041	backend easily beats IO::Lambda and POE.	2377	backend easily beats IO::Lambda and POE.
2042		2378
2043	And even the 100% non-blocking version written using the high-level (and	2379	And even the 100% non-blocking version written using the high-level (and
2044	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2380	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2045	large margin, even though it does all of DNS, tcp-connect and socket I/O	2381	higher level ("unoptimised") abstractions by a large margin, even though
2046	in a non-blocking way.	2382	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2047		2383
2048	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2384	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2049	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2385	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2050	part of the IO::lambda distribution and were used without any changes.	2386	part of the IO::Lambda distribution and were used without any changes.
2051		2387
2052		2388
2053	=head1 SIGNALS	2389	=head1 SIGNALS
2054		2390
2055	AnyEvent currently installs handlers for these signals:	2391	AnyEvent currently installs handlers for these signals:
…		…
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	One of these modules is required when you want to read or write JSON data
		2486	via 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