[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.230 by root, Wed Jul 8 05:55:17 2009 UTC vs.
Revision 1.269 by root, Fri Jul 31 20:16:29 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> (or a naked file descriptor) to watch	195	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182	for events (AnyEvent might or might not keep a reference to this file	196	for events (AnyEvent might or might not keep a reference to this file
…		…
211	undef $w;	225	undef $w;
212	});	226	});
213		227
214	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
215		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	);
		237
216	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 >>
217	method with the following mandatory arguments:	239	method with the following mandatory arguments:
218		240
219	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
220	supported) the callback should be invoked. C<cb> is the callback to invoke	242	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
347		369
348	=back	370	=back
349		371
350	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
351		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		375
352	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
353	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
354	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
355		379
356	Although the callback might get passed parameters, their value and	380	Although the callback might get passed parameters, their value and
…		…
361	invocation, and callback invocation will be synchronous. Synchronous means	385	invocation, and callback invocation will be synchronous. Synchronous means
362	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,
363	but it is guaranteed not to interrupt any other callbacks.	387	but it is guaranteed not to interrupt any other callbacks.
364		388
365	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
366	between multiple watchers.	390	between multiple watchers, and AnyEvent will ensure that signals will not
		391	interrupt your program at bad times.
367		392
368	This watcher might use C<%SIG>, so programs overwriting those signals	393	This watcher might use C<%SIG> (depending on the event loop used),
369	directly will likely not work correctly.	394	so programs overwriting those signals directly will likely not work
		395	correctly.
370		396
371	Example: exit on SIGINT	397	Example: exit on SIGINT
372		398
373	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
374		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
375	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
376		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
377	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.
378		426
379	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,
380	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
381	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
382	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
383		432
384	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
385	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
386	callback arguments.	435	callback arguments.
387		436
…		…
403		452
404	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
405	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
406	watcher before you C<fork> the child (alternatively, you can call	455	watcher before you C<fork> the child (alternatively, you can call
407	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.
408		461
409	Example: fork a process and wait for it	462	Example: fork a process and wait for it
410		463
411	my $done = AnyEvent->condvar;	464	my $done = AnyEvent->condvar;
412		465
…		…
424	# do something else, then wait for process exit	477	# do something else, then wait for process exit
425	$done->recv;	478	$done->recv;
426		479
427	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
428		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
429	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
430	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
431	"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
432	attention by the event loop".	487	attention by the event loop".
433		488
…		…
459	});	514	});
460	});	515	});
461		516
462	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
463		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
464	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
465	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
466	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
467		527
468	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
469	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).
470		530
471	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
472	because they represent a condition that must become true.	532	because they represent a condition that must become true.
473		533
		534	Now is probably a good time to look at the examples further below.
		535
474	Condition variables can be created by calling the C<< AnyEvent->condvar	536	Condition variables can be created by calling the C<< AnyEvent->condvar
475	>> method, usually without arguments. The only argument pair allowed is	537	>> method, usually without arguments. The only argument pair allowed is
476
477	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
478	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
479	the results).	540	the results).
480		541
481	After creation, the condition variable is "false" until it becomes "true"	542	After creation, the condition variable is "false" until it becomes "true"
…		…
486	Condition variables are similar to callbacks, except that you can	547	Condition variables are similar to callbacks, except that you can
487	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
488	in time where multiple outstanding events have been processed. And yet	549	in time where multiple outstanding events have been processed. And yet
489	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
490	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
491	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.
492		554
493	Condition variables are very useful to signal that something has finished,	555	Condition variables are very useful to signal that something has finished,
494	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,
495	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
496	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
…		…
530	after => 1,	592	after => 1,
531	cb => sub { $result_ready->send },	593	cb => sub { $result_ready->send },
532	);	594	);
533		595
534	# this "blocks" (while handling events) till the callback	596	# this "blocks" (while handling events) till the callback
535	# calls send	597	# calls -<send
536	$result_ready->recv;	598	$result_ready->recv;
537		599
538	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
539	condition variables are also code references.	601	variables are also callable directly.
540		602
541	my $done = AnyEvent->condvar;	603	my $done = AnyEvent->condvar;
542	my $delay = AnyEvent->timer (after => 5, cb => $done);	604	my $delay = AnyEvent->timer (after => 5, cb => $done);
543	$done->recv;	605	$done->recv;
544		606
…		…
550		612
551	...	613	...
552		614
553	my @info = $couchdb->info->recv;	615	my @info = $couchdb->info->recv;
554		616
555	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
556	results are available:	618	results are available:
557		619
558	$couchdb->info->cb (sub {	620	$couchdb->info->cb (sub {
559	my @info = $_[0]->recv;	621	my @info = $_[0]->recv;
560	});	622	});
…		…
578	immediately from within send.	640	immediately from within send.
579		641
580	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
581	future C<< ->recv >> calls.	643	future C<< ->recv >> calls.
582		644
583	Condition variables are overloaded so one can call them directly	645	Condition variables are overloaded so one can call them directly (as if
584	(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
585	C<send>. Note, however, that many C-based event loops do not handle	647	C<send>.
586	overloading, so as tempting as it may be, passing a condition variable
587	instead of a callback does not work. Both the pure perl and EV loops
588	support overloading, however, as well as all functions that use perl to
589	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
590	example).
591		648
592	=item $cv->croak ($error)	649	=item $cv->croak ($error)
593		650
594	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
595	C<Carp::croak> with the given error message/object/scalar.	652	C<Carp::croak> with the given error message/object/scalar.
596		653
597	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
598	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.
599		660
600	=item $cv->begin ([group callback])	661	=item $cv->begin ([group callback])
601		662
602	=item $cv->end	663	=item $cv->end
603		664
…		…
699	function will call C<croak>.	760	function will call C<croak>.
700		761
701	In list context, all parameters passed to C<send> will be returned,	762	In list context, all parameters passed to C<send> will be returned,
702	in scalar context only the first one will be returned.	763	in scalar context only the first one will be returned.
703		764
		765	Note that doing a blocking wait in a callback is not supported by any
		766	event loop, that is, recursive invocation of a blocking C<< ->recv
		767	>> is not allowed, and the C<recv> call will C<croak> if such a
		768	condition is detected. This condition can be slightly loosened by using
		769	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		770	any thread that doesn't run the event loop itself.
		771
704	Not all event models support a blocking wait - some die in that case	772	Not all event models support a blocking wait - some die in that case
705	(programs might want to do that to stay interactive), so I<if you are	773	(programs might want to do that to stay interactive), so I<if you are
706	using this from a module, never require a blocking wait>, but let the	774	using this from a module, never require a blocking wait>. Instead, let the
707	caller decide whether the call will block or not (for example, by coupling	775	caller decide whether the call will block or not (for example, by coupling
708	condition variables with some kind of request results and supporting	776	condition variables with some kind of request results and supporting
709	callbacks so the caller knows that getting the result will not block,	777	callbacks so the caller knows that getting the result will not block,
710	while still supporting blocking waits if the caller so desires).	778	while still supporting blocking waits if the caller so desires).
711		779
712	Another reason I<never> to C<< ->recv >> in a module is that you cannot
713	sensibly have two C<< ->recv >>'s in parallel, as that would require
714	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
715	can supply.
716
717	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
718	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
719	versions and also integrates coroutines into AnyEvent, making blocking
720	C<< ->recv >> calls perfectly safe as long as they are done from another
721	coroutine (one that doesn't run the event loop).
722
723	You can ensure that C<< -recv >> never blocks by setting a callback and	780	You can ensure that C<< -recv >> never blocks by setting a callback and
724	only calling C<< ->recv >> from within that callback (or at a later	781	only calling C<< ->recv >> from within that callback (or at a later
725	time). This will work even when the event loop does not support blocking	782	time). This will work even when the event loop does not support blocking
726	waits otherwise.	783	waits otherwise.
727		784
…		…
733	=item $cb = $cv->cb ($cb->($cv))	790	=item $cb = $cv->cb ($cb->($cv))
734		791
735	This is a mutator function that returns the callback set and optionally	792	This is a mutator function that returns the callback set and optionally
736	replaces it before doing so.	793	replaces it before doing so.
737		794
738	The callback will be called when the condition becomes "true", i.e. when	795	The callback will be called when the condition becomes (or already was)
739	C<send> or C<croak> are called, with the only argument being the condition	796	"true", i.e. when C<send> or C<croak> are called (or were called), with
740	variable itself. Calling C<recv> inside the callback or at any later time	797	the only argument being the condition variable itself. Calling C<recv>
741	is guaranteed not to block.	798	inside the callback or at any later time is guaranteed not to block.
742		799
743	=back	800	=back
744		801
		802	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		803
		804	The available backend classes are (every class has its own manpage):
		805
		806	=over 4
		807
		808	=item Backends that are autoprobed when no other event loop can be found.
		809
		810	EV is the preferred backend when no other event loop seems to be in
		811	use. If EV is not installed, then AnyEvent will try Event, and, failing
		812	that, will fall back to its own pure-perl implementation, which is
		813	available everywhere as it comes with AnyEvent itself.
		814
		815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		816	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		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::Glib based on Glib, slow but very stable.
		828	AnyEvent::Impl::Tk based on Tk, very broken.
		829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		830	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		831	AnyEvent::Impl::Irssi used when running within irssi.
		832
		833	=item Backends with special needs.
		834
		835	Qt requires the Qt::Application to be instantiated first, but will
		836	otherwise be picked up automatically. As long as the main program
		837	instantiates the application before any AnyEvent watchers are created,
		838	everything should just work.
		839
		840	AnyEvent::Impl::Qt based on Qt.
		841
		842	Support for IO::Async can only be partial, as it is too broken and
		843	architecturally limited to even support the AnyEvent API. It also
		844	is the only event loop that needs the loop to be set explicitly, so
		845	it can only be used by a main program knowing about AnyEvent. See
		846	L<AnyEvent::Impl::Async> for the gory details.
		847
		848	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		849
		850	=item Event loops that are indirectly supported via other backends.
		851
		852	Some event loops can be supported via other modules:
		853
		854	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		855
		856	B<WxWidgets> has no support for watching file handles. However, you can
		857	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		858	polls 20 times per second, which was considered to be too horrible to even
		859	consider for AnyEvent.
		860
		861	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		862	backend, so it can be supported through POE.
		863
		864	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		865	load L<POE> when detecting them, in the hope that POE will pick them up,
		866	in which case everything will be automatic.
		867
		868	=back
		869
745	=head1 GLOBAL VARIABLES AND FUNCTIONS	870	=head1 GLOBAL VARIABLES AND FUNCTIONS
746		871
		872	These are not normally required to use AnyEvent, but can be useful to
		873	write AnyEvent extension modules.
		874
747	=over 4	875	=over 4
748		876
749	=item $AnyEvent::MODEL	877	=item $AnyEvent::MODEL
750		878
751	Contains C<undef> until the first watcher is being created. Then it	879	Contains C<undef> until the first watcher is being created, before the
		880	backend has been autodetected.
		881
752	contains the event model that is being used, which is the name of the	882	Afterwards it contains the event model that is being used, which is the
753	Perl class implementing the model. This class is usually one of the	883	name of the Perl class implementing the model. This class is usually one
754	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	884	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
755	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	885	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
756		886	will be C<urxvt::anyevent>).
757	The known classes so far are:
758
759	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
760	AnyEvent::Impl::Event based on Event, second best choice.
761	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
762	AnyEvent::Impl::Glib based on Glib, third-best choice.
763	AnyEvent::Impl::Tk based on Tk, very bad choice.
764	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
765	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
766	AnyEvent::Impl::POE based on POE, not generic enough for full support.
767
768	# warning, support for IO::Async is only partial, as it is too broken
769	# and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
770	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
771
772	There is no support for WxWidgets, as WxWidgets has no support for
773	watching file handles. However, you can use WxWidgets through the
774	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
775	second, which was considered to be too horrible to even consider for
776	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
777	it's adaptor.
778
779	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
780	autodetecting them.
781		887
782	=item AnyEvent::detect	888	=item AnyEvent::detect
783		889
784	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	890	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
785	if necessary. You should only call this function right before you would	891	if necessary. You should only call this function right before you would
786	have created an AnyEvent watcher anyway, that is, as late as possible at	892	have created an AnyEvent watcher anyway, that is, as late as possible at
787	runtime.	893	runtime, and not e.g. while initialising of your module.
		894
		895	If you need to do some initialisation before AnyEvent watchers are
		896	created, use C<post_detect>.
788		897
789	=item $guard = AnyEvent::post_detect { BLOCK }	898	=item $guard = AnyEvent::post_detect { BLOCK }
790		899
791	Arranges for the code block to be executed as soon as the event model is	900	Arranges for the code block to be executed as soon as the event model is
792	autodetected (or immediately if this has already happened).	901	autodetected (or immediately if this has already happened).
793		902
		903	The block will be executed I<after> the actual backend has been detected
		904	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		905	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		906	other initialisations - see the sources of L<AnyEvent::Strict> or
		907	L<AnyEvent::AIO> to see how this is used.
		908
		909	The most common usage is to create some global watchers, without forcing
		910	event module detection too early, for example, L<AnyEvent::AIO> creates
		911	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		912	avoid autodetecting the event module at load time.
		913
794	If called in scalar or list context, then it creates and returns an object	914	If called in scalar or list context, then it creates and returns an object
795	that automatically removes the callback again when it is destroyed. See	915	that automatically removes the callback again when it is destroyed (or
		916	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
796	L<Coro::BDB> for a case where this is useful.	917	a case where this is useful.
		918
		919	Example: Create a watcher for the IO::AIO module and store it in
		920	C<$WATCHER>. Only do so after the event loop is initialised, though.
		921
		922	our WATCHER;
		923
		924	my $guard = AnyEvent::post_detect {
		925	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		926	};
		927
		928	# the \|\|= is important in case post_detect immediately runs the block,
		929	# as to not clobber the newly-created watcher. assigning both watcher and
		930	# post_detect guard to the same variable has the advantage of users being
		931	# able to just C<undef $WATCHER> if the watcher causes them grief.
		932
		933	$WATCHER \|\|= $guard;
797		934
798	=item @AnyEvent::post_detect	935	=item @AnyEvent::post_detect
799		936
800	If there are any code references in this array (you can C<push> to it	937	If there are any code references in this array (you can C<push> to it
801	before or after loading AnyEvent), then they will called directly after	938	before or after loading AnyEvent), then they will called directly after
802	the event loop has been chosen.	939	the event loop has been chosen.
803		940
804	You should check C<$AnyEvent::MODEL> before adding to this array, though:	941	You should check C<$AnyEvent::MODEL> before adding to this array, though:
805	if it contains a true value then the event loop has already been detected,	942	if it is defined then the event loop has already been detected, and the
806	and the array will be ignored.	943	array will be ignored.
807		944
808	Best use C<AnyEvent::post_detect { BLOCK }> instead.	945	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		946	it,as it takes care of these details.
		947
		948	This variable is mainly useful for modules that can do something useful
		949	when AnyEvent is used and thus want to know when it is initialised, but do
		950	not need to even load it by default. This array provides the means to hook
		951	into AnyEvent passively, without loading it.
809		952
810	=back	953	=back
811		954
812	=head1 WHAT TO DO IN A MODULE	955	=head1 WHAT TO DO IN A MODULE
813		956
…		…
960		1103
961	=cut	1104	=cut
962		1105
963	package AnyEvent;	1106	package AnyEvent;
964		1107
		1108	# basically a tuned-down version of common::sense
		1109	sub common_sense {
965	no warnings;	1110	# no warnings
		1111	${^WARNING_BITS} ^= ${^WARNING_BITS};
966	use strict qw(vars subs);	1112	# use strict vars subs
		1113	$^H \|= 0x00000600;
		1114	}
967		1115
		1116	BEGIN { AnyEvent::common_sense }
		1117
968	use Carp;	1118	use Carp ();
969		1119
970	our $VERSION = 4.8;	1120	our $VERSION = 4.9;
971	our $MODEL;	1121	our $MODEL;
972		1122
973	our $AUTOLOAD;	1123	our $AUTOLOAD;
974	our @ISA;	1124	our @ISA;
975		1125
976	our @REGISTRY;	1126	our @REGISTRY;
977		1127
978	our $WIN32;	1128	our $WIN32;
		1129
		1130	our $VERBOSE;
979		1131
980	BEGIN {	1132	BEGIN {
981	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
982	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
983		1135
984	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
985	if ${^TAINT};	1137	if ${^TAINT};
986	}
987		1138
988	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1140
		1141	}
		1142
		1143	our $MAX_SIGNAL_LATENCY = 10;
989		1144
990	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1145	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
991		1146
992	{	1147	{
993	my $idx;	1148	my $idx;
…		…
995	for reverse split /\s,\s/,	1150	for reverse split /\s,\s/,
996	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
997	}	1152	}
998		1153
999	my @models = (	1154	my @models = (
1000	[EV:: => AnyEvent::Impl::EV::],	1155	[EV:: => AnyEvent::Impl::EV:: , 1],
1001	[Event:: => AnyEvent::Impl::Event::],	1156	[Event:: => AnyEvent::Impl::Event::, 1],
1002	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1003	# everything below here will not be autoprobed	1158	# everything below here will not (normally) be autoprobed
1004	# as the pureperl backend should work everywhere	1159	# as the pureperl backend should work everywhere
1005	# and is usually faster	1160	# and is usually faster
		1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1006	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1007	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1008	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1009	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1010	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1011	[Wx:: => AnyEvent::Impl::POE::],	1167	[Wx:: => AnyEvent::Impl::POE::],
1012	[Prima:: => AnyEvent::Impl::POE::],	1168	[Prima:: => AnyEvent::Impl::POE::],
1013	# IO::Async is just too broken - we would need workaorunds for its	1169	# IO::Async is just too broken - we would need workarounds for its
1014	# byzantine signal and broken child handling, among others.	1170	# byzantine signal and broken child handling, among others.
1015	# IO::Async is rather hard to detect, as it doesn't have any	1171	# IO::Async is rather hard to detect, as it doesn't have any
1016	# obvious default class.	1172	# obvious default class.
1017	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1018	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1019	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1020	);	1176	);
1021		1177
1022	our %method = map +($_ => 1),	1178	our %method = map +($_ => 1),
1023	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1179	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1024		1180
…		…
1028	my ($cb) = @_;	1184	my ($cb) = @_;
1029		1185
1030	if ($MODEL) {	1186	if ($MODEL) {
1031	$cb->();	1187	$cb->();
1032		1188
1033	1	1189	undef
1034	} else {	1190	} else {
1035	push @post_detect, $cb;	1191	push @post_detect, $cb;
1036		1192
1037	defined wantarray	1193	defined wantarray
1038	? bless \$cb, "AnyEvent::Util::postdetect"	1194	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1044	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1200	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1045	}	1201	}
1046		1202
1047	sub detect() {	1203	sub detect() {
1048	unless ($MODEL) {	1204	unless ($MODEL) {
1049	no strict 'refs';
1050	local $SIG{__DIE__};	1205	local $SIG{__DIE__};
1051		1206
1052	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1207	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1053	my $model = "AnyEvent::Impl::$1";	1208	my $model = "AnyEvent::Impl::$1";
1054	if (eval "require $model") {	1209	if (eval "require $model") {
1055	$MODEL = $model;	1210	$MODEL = $model;
1056	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1211	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1057	} else {	1212	} else {
1058	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1213	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1059	}	1214	}
1060	}	1215	}
1061		1216
1062	# check for already loaded models	1217	# check for already loaded models
1063	unless ($MODEL) {	1218	unless ($MODEL) {
1064	for (@REGISTRY, @models) {	1219	for (@REGISTRY, @models) {
1065	my ($package, $model) = @$_;	1220	my ($package, $model) = @$_;
1066	if (${"$package\::VERSION"} > 0) {	1221	if (${"$package\::VERSION"} > 0) {
1067	if (eval "require $model") {	1222	if (eval "require $model") {
1068	$MODEL = $model;	1223	$MODEL = $model;
1069	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1224	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1070	last;	1225	last;
1071	}	1226	}
1072	}	1227	}
1073	}	1228	}
1074		1229
1075	unless ($MODEL) {	1230	unless ($MODEL) {
1076	# try to load a model	1231	# try to autoload a model
1077
1078	for (@REGISTRY, @models) {	1232	for (@REGISTRY, @models) {
1079	my ($package, $model) = @$_;	1233	my ($package, $model, $autoload) = @$_;
		1234	if (
		1235	$autoload
1080	if (eval "require $package"	1236	and eval "require $package"
1081	and ${"$package\::VERSION"} > 0	1237	and ${"$package\::VERSION"} > 0
1082	and eval "require $model") {	1238	and eval "require $model"
		1239	) {
1083	$MODEL = $model;	1240	$MODEL = $model;
1084	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1241	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1085	last;	1242	last;
1086	}	1243	}
1087	}	1244	}
1088		1245
1089	$MODEL	1246	$MODEL
…		…
1105		1262
1106	sub AUTOLOAD {	1263	sub AUTOLOAD {
1107	(my $func = $AUTOLOAD) =~ s/.*://;	1264	(my $func = $AUTOLOAD) =~ s/.*://;
1108		1265
1109	$method{$func}	1266	$method{$func}
1110	or croak "$func: not a valid method for AnyEvent objects";	1267	or Carp::croak "$func: not a valid method for AnyEvent objects";
1111		1268
1112	detect unless $MODEL;	1269	detect unless $MODEL;
1113		1270
1114	my $class = shift;	1271	my $class = shift;
1115	$class->$func (@_);	1272	$class->$func (@_);
…		…
1120	# allow only one watcher per fd, so we dup it to get a different one).	1277	# allow only one watcher per fd, so we dup it to get a different one).
1121	sub _dupfh($$;$$) {	1278	sub _dupfh($$;$$) {
1122	my ($poll, $fh, $r, $w) = @_;	1279	my ($poll, $fh, $r, $w) = @_;
1123		1280
1124	# cygwin requires the fh mode to be matching, unix doesn't	1281	# cygwin requires the fh mode to be matching, unix doesn't
1125	my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">");	1282	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1126		1283
1127	open my $fh2, "$mode&", $fh	1284	open my $fh2, $mode, $fh
1128	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";	1285	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1129		1286
1130	# we assume CLOEXEC is already set by perl in all important cases	1287	# we assume CLOEXEC is already set by perl in all important cases
1131		1288
1132	($fh2, $rw)	1289	($fh2, $rw)
…		…
1134		1291
1135	package AnyEvent::Base;	1292	package AnyEvent::Base;
1136		1293
1137	# default implementations for many methods	1294	# default implementations for many methods
1138		1295
1139	BEGIN {	1296	sub _time {
		1297	# probe for availability of Time::HiRes
1140	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1298	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1299	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1141	*_time = \&Time::HiRes::time;	1300	*_time = \&Time::HiRes::time;
1142	# if (eval "use POSIX (); (POSIX::times())...	1301	# if (eval "use POSIX (); (POSIX::times())...
1143	} else {	1302	} else {
		1303	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1144	*_time = sub { time }; # epic fail	1304	*_time = sub { time }; # epic fail
1145	}	1305	}
		1306
		1307	&_time
1146	}	1308	}
1147		1309
1148	sub time { _time }	1310	sub time { _time }
1149	sub now { _time }	1311	sub now { _time }
1150	sub now_update { }	1312	sub now_update { }
…		…
1155	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1317	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1156	}	1318	}
1157		1319
1158	# default implementation for ->signal	1320	# default implementation for ->signal
1159		1321
		1322	our $HAVE_ASYNC_INTERRUPT;
		1323
		1324	sub _have_async_interrupt() {
		1325	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1326	&& eval "use Async::Interrupt 1.0 (); 1")
		1327	unless defined $HAVE_ASYNC_INTERRUPT;
		1328
		1329	$HAVE_ASYNC_INTERRUPT
		1330	}
		1331
1160	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1332	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1333	our (%SIG_ASY, %SIG_ASY_W);
		1334	our ($SIG_COUNT, $SIG_TW);
1161		1335
1162	sub _signal_exec {	1336	sub _signal_exec {
		1337	$HAVE_ASYNC_INTERRUPT
		1338	? $SIGPIPE_R->drain
1163	sysread $SIGPIPE_R, my $dummy, 4;	1339	: sysread $SIGPIPE_R, my $dummy, 9;
1164		1340
1165	while (%SIG_EV) {	1341	while (%SIG_EV) {
1166	for (keys %SIG_EV) {	1342	for (keys %SIG_EV) {
1167	delete $SIG_EV{$_};	1343	delete $SIG_EV{$_};
1168	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1344	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1169	}	1345	}
1170	}	1346	}
1171	}	1347	}
1172		1348
		1349	# install a dummy wakeup watcher to reduce signal catching latency
		1350	sub _sig_add() {
		1351	unless ($SIG_COUNT++) {
		1352	# try to align timer on a full-second boundary, if possible
		1353	my $NOW = AnyEvent->now;
		1354
		1355	$SIG_TW = AnyEvent->timer (
		1356	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1357	interval => $MAX_SIGNAL_LATENCY,
		1358	cb => sub { }, # just for the PERL_ASYNC_CHECK
		1359	);
		1360	}
		1361	}
		1362
		1363	sub _sig_del {
		1364	undef $SIG_TW
		1365	unless --$SIG_COUNT;
		1366	}
		1367
		1368	our $_sig_name_init; $_sig_name_init = sub {
		1369	eval q{ # poor man's autoloading
		1370	undef $_sig_name_init;
		1371
		1372	if (_have_async_interrupt) {
		1373	*sig2num = \&Async::Interrupt::sig2num;
		1374	*sig2name = \&Async::Interrupt::sig2name;
		1375	} else {
		1376	require Config;
		1377
		1378	my %signame2num;
		1379	@signame2num{ split ' ', $Config::Config{sig_name} }
		1380	= split ' ', $Config::Config{sig_num};
		1381
		1382	my @signum2name;
		1383	@signum2name[values %signame2num] = keys %signame2num;
		1384
		1385	*sig2num = sub($) {
		1386	$_[0] > 0 ? shift : $signame2num{+shift}
		1387	};
		1388	*sig2name = sub ($) {
		1389	$_[0] > 0 ? $signum2name[+shift] : shift
		1390	};
		1391	}
		1392	};
		1393	die if $@;
		1394	};
		1395
		1396	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1397	sub sig2name($) { &$_sig_name_init; &sig2name }
		1398
1173	sub signal {	1399	sub signal {
1174	my (undef, %arg) = @_;	1400	eval q{ # poor man's autoloading {}
		1401	# probe for availability of Async::Interrupt
		1402	if (_have_async_interrupt) {
		1403	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1175		1404
1176	unless ($SIGPIPE_R) {	1405	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1177	require Fcntl;	1406	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1178		1407
1179	if (AnyEvent::WIN32) {
1180	require AnyEvent::Util;
1181
1182	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1183	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1184	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1185	} else {	1408	} else {
		1409	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1410
		1411	require Fcntl;
		1412
		1413	if (AnyEvent::WIN32) {
		1414	require AnyEvent::Util;
		1415
		1416	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1417	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1418	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1419	} else {
1186	pipe $SIGPIPE_R, $SIGPIPE_W;	1420	pipe $SIGPIPE_R, $SIGPIPE_W;
1187	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1421	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1188	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1422	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1189		1423
1190	# not strictly required, as $^F is normally 2, but let's make sure...	1424	# not strictly required, as $^F is normally 2, but let's make sure...
1191	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1425	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1192	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1426	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1427	}
		1428
		1429	$SIGPIPE_R
		1430	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1431
		1432	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1193	}	1433	}
1194		1434
1195	$SIGPIPE_R	1435	*signal = sub {
1196	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1436	my (undef, %arg) = @_;
1197		1437
1198	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1199	}
1200
1201	my $signal = uc $arg{signal}	1438	my $signal = uc $arg{signal}
1202	or Carp::croak "required option 'signal' is missing";	1439	or Carp::croak "required option 'signal' is missing";
1203		1440
		1441	if ($HAVE_ASYNC_INTERRUPT) {
		1442	# async::interrupt
		1443
		1444	$signal = sig2num $signal;
1204	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1445	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1446
		1447	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1448	cb => sub { undef $SIG_EV{$signal} },
		1449	signal => $signal,
		1450	pipe => [$SIGPIPE_R->filenos],
		1451	pipe_autodrain => 0,
		1452	;
		1453
		1454	} else {
		1455	# pure perl
		1456
		1457	# AE::Util has been loaded in signal
		1458	$signal = sig2name $signal;
		1459	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1460
1205	$SIG{$signal} \|\|= sub {	1461	$SIG{$signal} \|\|= sub {
1206	local $!;	1462	local $!;
1207	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1463	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1208	undef $SIG_EV{$signal};	1464	undef $SIG_EV{$signal};
		1465	};
		1466
		1467	# can't do signal processing without introducing races in pure perl,
		1468	# so limit the signal latency.
		1469	_sig_add;
		1470	}
		1471
		1472	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1473	};
		1474
		1475	*AnyEvent::Base::signal::DESTROY = sub {
		1476	my ($signal, $cb) = @{$_[0]};
		1477
		1478	_sig_del;
		1479
		1480	delete $SIG_CB{$signal}{$cb};
		1481
		1482	$HAVE_ASYNC_INTERRUPT
		1483	? delete $SIG_ASY{$signal}
		1484	: # delete doesn't work with older perls - they then
		1485	# print weird messages, or just unconditionally exit
		1486	# instead of getting the default action.
		1487	undef $SIG{$signal}
		1488	unless keys %{ $SIG_CB{$signal} };
		1489	};
1209	};	1490	};
1210		1491	die if $@;
1211	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1492	&signal
1212	}
1213
1214	sub AnyEvent::Base::signal::DESTROY {
1215	my ($signal, $cb) = @{$_[0]};
1216
1217	delete $SIG_CB{$signal}{$cb};
1218
1219	# delete doesn't work with older perls - they then
1220	# print weird messages, or just unconditionally exit
1221	# instead of getting the default action.
1222	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1223	}	1493	}
1224		1494
1225	# default implementation for ->child	1495	# default implementation for ->child
1226		1496
1227	our %PID_CB;	1497	our %PID_CB;
1228	our $CHLD_W;	1498	our $CHLD_W;
1229	our $CHLD_DELAY_W;	1499	our $CHLD_DELAY_W;
1230	our $WNOHANG;	1500	our $WNOHANG;
1231		1501
		1502	sub _emit_childstatus($$) {
		1503	my (undef, $rpid, $rstatus) = @_;
		1504
		1505	$_->($rpid, $rstatus)
		1506	for values %{ $PID_CB{$rpid} \|\| {} },
		1507	values %{ $PID_CB{0} \|\| {} };
		1508	}
		1509
1232	sub _sigchld {	1510	sub _sigchld {
		1511	my $pid;
		1512
		1513	AnyEvent->_emit_childstatus ($pid, $?)
1233	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1514	while ($pid = waitpid -1, $WNOHANG) > 0;
1234	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
1235	(values %{ $PID_CB{0} \|\| {} });
1236	}
1237	}	1515	}
1238		1516
1239	sub child {	1517	sub child {
1240	my (undef, %arg) = @_;	1518	my (undef, %arg) = @_;
1241		1519
1242	defined (my $pid = $arg{pid} + 0)	1520	defined (my $pid = $arg{pid} + 0)
1243	or Carp::croak "required option 'pid' is missing";	1521	or Carp::croak "required option 'pid' is missing";
1244		1522
1245	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1523	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1246		1524
		1525	# WNOHANG is almost cetrainly 1 everywhere
		1526	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1527	? 1
1247	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1528	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1248		1529
1249	unless ($CHLD_W) {	1530	unless ($CHLD_W) {
1250	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1531	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1251	# child could be a zombie already, so make at least one round	1532	# child could be a zombie already, so make at least one round
1252	&_sigchld;	1533	&_sigchld;
…		…
1304		1585
1305	our @ISA = AnyEvent::CondVar::Base::;	1586	our @ISA = AnyEvent::CondVar::Base::;
1306		1587
1307	package AnyEvent::CondVar::Base;	1588	package AnyEvent::CondVar::Base;
1308		1589
1309	use overload	1590	#use overload
1310	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1591	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1311	fallback => 1;	1592	# fallback => 1;
		1593
		1594	# save 300+ kilobytes by dirtily hardcoding overloading
		1595	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1596	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1597	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1598	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1599
		1600	our $WAITING;
1312		1601
1313	sub _send {	1602	sub _send {
1314	# nop	1603	# nop
1315	}	1604	}
1316		1605
…		…
1329	sub ready {	1618	sub ready {
1330	$_[0]{_ae_sent}	1619	$_[0]{_ae_sent}
1331	}	1620	}
1332		1621
1333	sub _wait {	1622	sub _wait {
		1623	$WAITING
		1624	and !$_[0]{_ae_sent}
		1625	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1626
		1627	local $WAITING = 1;
1334	AnyEvent->one_event while !$_[0]{_ae_sent};	1628	AnyEvent->one_event while !$_[0]{_ae_sent};
1335	}	1629	}
1336		1630
1337	sub recv {	1631	sub recv {
1338	$_[0]->_wait;	1632	$_[0]->_wait;
…		…
1340	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1634	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1341	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1635	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1342	}	1636	}
1343		1637
1344	sub cb {	1638	sub cb {
1345	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1639	my $cv = shift;
		1640
		1641	@_
		1642	and $cv->{_ae_cb} = shift
		1643	and $cv->{_ae_sent}
		1644	and (delete $cv->{_ae_cb})->($cv);
1346	$_[0]{_ae_cb}	1645	$cv->{_ae_cb}
1347	}	1646	}
1348		1647
1349	sub begin {	1648	sub begin {
1350	++$_[0]{_ae_counter};	1649	++$_[0]{_ae_counter};
1351	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1650	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1357	}	1656	}
1358		1657
1359	# undocumented/compatibility with pre-3.4	1658	# undocumented/compatibility with pre-3.4
1360	*broadcast = \&send;	1659	*broadcast = \&send;
1361	*wait = \&_wait;	1660	*wait = \&_wait;
		1661
		1662	#############################################################################
		1663	# "new" API, currently only emulation of it
		1664	#############################################################################
		1665
		1666	package AE;
		1667
		1668	sub io($$$) {
		1669	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1670	}
		1671
		1672	sub timer($$$) {
		1673	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
		1674	}
		1675
		1676	sub signal($$) {
		1677	AnyEvent->signal (signal => $_[0], cb => $_[1]);
		1678	}
		1679
		1680	sub child($$) {
		1681	AnyEvent->child (pid => $_[0], cb => $_[1]);
		1682	}
		1683
		1684	sub idle($) {
		1685	AnyEvent->idle (cb => $_[0]);
		1686	}
		1687
		1688	sub cv() {
		1689	AnyEvent->condvar
		1690	}
		1691
		1692	sub now() {
		1693	AnyEvent->now
		1694	}
		1695
		1696	sub now_update() {
		1697	AnyEvent->now_update
		1698	}
		1699
		1700	sub time() {
		1701	AnyEvent->time
		1702	}
1362		1703
1363	=head1 ERROR AND EXCEPTION HANDLING	1704	=head1 ERROR AND EXCEPTION HANDLING
1364		1705
1365	In general, AnyEvent does not do any error handling - it relies on the	1706	In general, AnyEvent does not do any error handling - it relies on the
1366	caller to do that if required. The L<AnyEvent::Strict> module (see also	1707	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1400	C<PERL_ANYEVENT_MODEL>.	1741	C<PERL_ANYEVENT_MODEL>.
1401		1742
1402	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1743	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1403	model it chooses.	1744	model it chooses.
1404		1745
		1746	When set to C<8> or higher, then AnyEvent will report extra information on
		1747	which optional modules it loads and how it implements certain features.
		1748
1405	=item C<PERL_ANYEVENT_STRICT>	1749	=item C<PERL_ANYEVENT_STRICT>
1406		1750
1407	AnyEvent does not do much argument checking by default, as thorough	1751	AnyEvent does not do much argument checking by default, as thorough
1408	argument checking is very costly. Setting this variable to a true value	1752	argument checking is very costly. Setting this variable to a true value
1409	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1753	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1410	check the arguments passed to most method calls. If it finds any problems,	1754	check the arguments passed to most method calls. If it finds any problems,
1411	it will croak.	1755	it will croak.
1412		1756
1413	In other words, enables "strict" mode.	1757	In other words, enables "strict" mode.
1414		1758
1415	Unlike C<use strict>, it is definitely recommended to keep it off in	1759	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1416	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1760	>>, it is definitely recommended to keep it off in production. Keeping
1417	developing programs can be very useful, however.	1761	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1762	can be very useful, however.
1418		1763
1419	=item C<PERL_ANYEVENT_MODEL>	1764	=item C<PERL_ANYEVENT_MODEL>
1420		1765
1421	This can be used to specify the event model to be used by AnyEvent, before	1766	This can be used to specify the event model to be used by AnyEvent, before
1422	auto detection and -probing kicks in. It must be a string consisting	1767	auto detection and -probing kicks in. It must be a string consisting
…		…
1484		1829
1485	When neither C<ca_file> nor C<ca_path> was specified during	1830	When neither C<ca_file> nor C<ca_path> was specified during
1486	L<AnyEvent::TLS> context creation, and either of these environment	1831	L<AnyEvent::TLS> context creation, and either of these environment
1487	variables exist, they will be used to specify CA certificate locations	1832	variables exist, they will be used to specify CA certificate locations
1488	instead of a system-dependent default.	1833	instead of a system-dependent default.
		1834
		1835	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1836
		1837	When these are set to C<1>, then the respective modules are not
		1838	loaded. Mostly good for testing AnyEvent itself.
1489		1839
1490	=back	1840	=back
1491		1841
1492	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1842	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1493		1843
…		…
2032		2382
2033	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2383	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2034	emulation for event loops that do not support them natively. Also, some	2384	emulation for event loops that do not support them natively. Also, some
2035	event loops install a similar handler.	2385	event loops install a similar handler.
2036		2386
2037	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will	2387	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2038	reset it to default, to avoid losing child exit statuses.	2388	AnyEvent will reset it to default, to avoid losing child exit statuses.
2039		2389
2040	=item SIGPIPE	2390	=item SIGPIPE
2041		2391
2042	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2392	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2043	when AnyEvent gets loaded.	2393	when AnyEvent gets loaded.
…		…
2061	if $SIG{CHLD} eq 'IGNORE';	2411	if $SIG{CHLD} eq 'IGNORE';
2062		2412
2063	$SIG{PIPE} = sub { }	2413	$SIG{PIPE} = sub { }
2064	unless defined $SIG{PIPE};	2414	unless defined $SIG{PIPE};
2065		2415
		2416	=head1 RECOMMENDED/OPTIONAL MODULES
		2417
		2418	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2419	it's built-in modules) are required to use it.
		2420
		2421	That does not mean that AnyEvent won't take advantage of some additional
		2422	modules if they are installed.
		2423
		2424	This section epxlains which additional modules will be used, and how they
		2425	affect AnyEvent's operetion.
		2426
		2427	=over 4
		2428
		2429	=item L<Async::Interrupt>
		2430
		2431	This slightly arcane module is used to implement fast signal handling: To
		2432	my knowledge, there is no way to do completely race-free and quick
		2433	signal handling in pure perl. To ensure that signals still get
		2434	delivered, AnyEvent will start an interval timer to wake up perl (and
		2435	catch the signals) with some delay (default is 10 seconds, look for
		2436	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2437
		2438	If this module is available, then it will be used to implement signal
		2439	catching, which means that signals will not be delayed, and the event loop
		2440	will not be interrupted regularly, which is more efficient (And good for
		2441	battery life on laptops).
		2442
		2443	This affects not just the pure-perl event loop, but also other event loops
		2444	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2445
		2446	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2447	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2448	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2449	does nothing for those backends.
		2450
		2451	=item L<EV>
		2452
		2453	This module isn't really "optional", as it is simply one of the backend
		2454	event loops that AnyEvent can use. However, it is simply the best event
		2455	loop available in terms of features, speed and stability: It supports
		2456	the AnyEvent API optimally, implements all the watcher types in XS, does
		2457	automatic timer adjustments even when no monotonic clock is available,
		2458	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2459	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2460	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2461
		2462	=item L<Guard>
		2463
		2464	The guard module, when used, will be used to implement
		2465	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2466	lot less memory), but otherwise doesn't affect guard operation much. It is
		2467	purely used for performance.
		2468
		2469	=item L<JSON> and L<JSON::XS>
		2470
		2471	This module is required when you want to read or write JSON data via
		2472	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2473	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2474
		2475	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2476	installed.
		2477
		2478	=item L<Net::SSLeay>
		2479
		2480	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2481	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2482	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2483
		2484	=item L<Time::HiRes>
		2485
		2486	This module is part of perl since release 5.008. It will be used when the
		2487	chosen event library does not come with a timing source on it's own. The
		2488	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2489	try to use a monotonic clock for timing stability.
		2490
		2491	=back
		2492
		2493
2066	=head1 FORK	2494	=head1 FORK
2067		2495
2068	Most event libraries are not fork-safe. The ones who are usually are	2496	Most event libraries are not fork-safe. The ones who are usually are
2069	because they rely on inefficient but fork-safe C<select> or C<poll>	2497	because they rely on inefficient but fork-safe C<select> or C<poll>
2070	calls. Only L<EV> is fully fork-aware.	2498	calls. Only L<EV> is fully fork-aware.
2071		2499
2072	If you have to fork, you must either do so I<before> creating your first	2500	If you have to fork, you must either do so I<before> creating your first
2073	watcher OR you must not use AnyEvent at all in the child.	2501	watcher OR you must not use AnyEvent at all in the child OR you must do
		2502	something completely out of the scope of AnyEvent.
2074		2503
2075		2504
2076	=head1 SECURITY CONSIDERATIONS	2505	=head1 SECURITY CONSIDERATIONS
2077		2506
2078	AnyEvent can be forced to load any event model via	2507	AnyEvent can be forced to load any event model via
…		…
2116	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2545	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2117		2546
2118	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2547	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2119	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2548	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2120	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2549	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2121	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2550	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2122		2551
2123	Non-blocking file handles, sockets, TCP clients and	2552	Non-blocking file handles, sockets, TCP clients and
2124	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2553	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2125		2554
2126	Asynchronous DNS: L<AnyEvent::DNS>.	2555	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.230 by root, Wed Jul 8 05:55:17 2009 UTC vs. Revision 1.269 by root, Fri Jul 31 20:16:29 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.230 by root, Wed Jul 8 05:55:17 2009 UTC vs.
Revision 1.269 by root, Fri Jul 31 20:16:29 2009 UTC