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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.224 by root, Fri Jul 3 21:44:14 2009 UTC vs.
Revision 1.266 by root, Thu Jul 30 03:41:56 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) 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
183	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.
…		…
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 do
		405	race-free signal handling in perl. AnyEvent will try to do it's best, but
		406	in some cases, signals will be delayed. The maximum time a signal might
		407	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
		408	seconds). This variable can be changed only before the first signal
		409	watcher is created, and should be left alone otherwise. Higher values
		410	will cause fewer spurious wake-ups, which is better for power and CPU
		411	saving. All these problems can be avoided by installing the optional
		412	L<Async::Interrupt> module. This will not work with inherently broken
		413	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
		414	currently, as POE does it's own workaround with one-second latency). With
		415	those, you just have to suffer the delays.
		416
375	=head2 CHILD PROCESS WATCHERS	417	=head2 CHILD PROCESS WATCHERS
376		418
		419	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		420
377	You can also watch on a child process exit and catch its exit status.	421	You can also watch on a child process exit and catch its exit status.
378		422
379	The child process is specified by the C<pid> argument (if set to C<0>, it	423	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	424	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	425	croak). The watcher will be triggered only when the child process has
382	any trace events (stopped/continued).	426	finished and an exit status is available, not on any trace events
		427	(stopped/continued).
383		428
384	The callback will be called with the pid and exit status (as returned by	429	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	430	waitpid), so unlike other watcher types, you I<can> rely on child watcher
386	callback arguments.	431	callback arguments.
387		432
…		…
403		448
404	This means you cannot create a child watcher as the very first	449	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	450	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	451	watcher before you C<fork> the child (alternatively, you can call
407	C<AnyEvent::detect>).	452	C<AnyEvent::detect>).
		453
		454	As most event loops do not support waiting for child events, they will be
		455	emulated by AnyEvent in most cases, in which the latency and race problems
		456	mentioned in the description of signal watchers apply.
408		457
409	Example: fork a process and wait for it	458	Example: fork a process and wait for it
410		459
411	my $done = AnyEvent->condvar;	460	my $done = AnyEvent->condvar;
412		461
…		…
424	# do something else, then wait for process exit	473	# do something else, then wait for process exit
425	$done->recv;	474	$done->recv;
426		475
427	=head2 IDLE WATCHERS	476	=head2 IDLE WATCHERS
428		477
		478	$w = AnyEvent->idle (cb => <callback>);
		479
429	Sometimes there is a need to do something, but it is not so important	480	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	481	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	482	"nothing better to do" is usually defined to be "no other events need
432	attention by the event loop".	483	attention by the event loop".
433		484
…		…
459	});	510	});
460	});	511	});
461		512
462	=head2 CONDITION VARIABLES	513	=head2 CONDITION VARIABLES
463		514
		515	$cv = AnyEvent->condvar;
		516
		517	$cv->send (<list>);
		518	my @res = $cv->recv;
		519
464	If you are familiar with some event loops you will know that all of them	520	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	521	require you to run some blocking "loop", "run" or similar function that
466	will actively watch for new events and call your callbacks.	522	will actively watch for new events and call your callbacks.
467		523
468	AnyEvent is different, it expects somebody else to run the event loop and	524	AnyEvent is slightly different: it expects somebody else to run the event
469	will only block when necessary (usually when told by the user).	525	loop and will only block when necessary (usually when told by the user).
470		526
471	The instrument to do that is called a "condition variable", so called	527	The instrument to do that is called a "condition variable", so called
472	because they represent a condition that must become true.	528	because they represent a condition that must become true.
473		529
		530	Now is probably a good time to look at the examples further below.
		531
474	Condition variables can be created by calling the C<< AnyEvent->condvar	532	Condition variables can be created by calling the C<< AnyEvent->condvar
475	>> method, usually without arguments. The only argument pair allowed is	533	>> 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	534	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	535	becomes true, with the condition variable as the first argument (but not
479	the results).	536	the results).
480		537
481	After creation, the condition variable is "false" until it becomes "true"	538	After creation, the condition variable is "false" until it becomes "true"
…		…
486	Condition variables are similar to callbacks, except that you can	543	Condition variables are similar to callbacks, except that you can
487	optionally wait for them. They can also be called merge points - points	544	optionally wait for them. They can also be called merge points - points
488	in time where multiple outstanding events have been processed. And yet	545	in time where multiple outstanding events have been processed. And yet
489	another way to call them is transactions - each condition variable can be	546	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	547	used to represent a transaction, which finishes at some point and delivers
491	a result.	548	a result. And yet some people know them as "futures" - a promise to
		549	compute/deliver something that you can wait for.
492		550
493	Condition variables are very useful to signal that something has finished,	551	Condition variables are very useful to signal that something has finished,
494	for example, if you write a module that does asynchronous http requests,	552	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	553	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	554	availability of results. The user can either act when the callback is
…		…
530	after => 1,	588	after => 1,
531	cb => sub { $result_ready->send },	589	cb => sub { $result_ready->send },
532	);	590	);
533		591
534	# this "blocks" (while handling events) till the callback	592	# this "blocks" (while handling events) till the callback
535	# calls send	593	# calls -<send
536	$result_ready->recv;	594	$result_ready->recv;
537		595
538	Example: wait for a timer, but take advantage of the fact that	596	Example: wait for a timer, but take advantage of the fact that condition
539	condition variables are also code references.	597	variables are also callable directly.
540		598
541	my $done = AnyEvent->condvar;	599	my $done = AnyEvent->condvar;
542	my $delay = AnyEvent->timer (after => 5, cb => $done);	600	my $delay = AnyEvent->timer (after => 5, cb => $done);
543	$done->recv;	601	$done->recv;
544		602
…		…
550		608
551	...	609	...
552		610
553	my @info = $couchdb->info->recv;	611	my @info = $couchdb->info->recv;
554		612
555	And this is how you would just ste a callback to be called whenever the	613	And this is how you would just set a callback to be called whenever the
556	results are available:	614	results are available:
557		615
558	$couchdb->info->cb (sub {	616	$couchdb->info->cb (sub {
559	my @info = $_[0]->recv;	617	my @info = $_[0]->recv;
560	});	618	});
…		…
578	immediately from within send.	636	immediately from within send.
579		637
580	Any arguments passed to the C<send> call will be returned by all	638	Any arguments passed to the C<send> call will be returned by all
581	future C<< ->recv >> calls.	639	future C<< ->recv >> calls.
582		640
583	Condition variables are overloaded so one can call them directly	641	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	642	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	643	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		644
592	=item $cv->croak ($error)	645	=item $cv->croak ($error)
593		646
594	Similar to send, but causes all call's to C<< ->recv >> to invoke	647	Similar to send, but causes all call's to C<< ->recv >> to invoke
595	C<Carp::croak> with the given error message/object/scalar.	648	C<Carp::croak> with the given error message/object/scalar.
596		649
597	This can be used to signal any errors to the condition variable	650	This can be used to signal any errors to the condition variable
598	user/consumer.	651	user/consumer. Doing it this way instead of calling C<croak> directly
		652	delays the error detetcion, but has the overwhelmign advantage that it
		653	diagnoses the error at the place where the result is expected, and not
		654	deep in some event clalback without connection to the actual code causing
		655	the problem.
599		656
600	=item $cv->begin ([group callback])	657	=item $cv->begin ([group callback])
601		658
602	=item $cv->end	659	=item $cv->end
603		660
…		…
699	function will call C<croak>.	756	function will call C<croak>.
700		757
701	In list context, all parameters passed to C<send> will be returned,	758	In list context, all parameters passed to C<send> will be returned,
702	in scalar context only the first one will be returned.	759	in scalar context only the first one will be returned.
703		760
		761	Note that doing a blocking wait in a callback is not supported by any
		762	event loop, that is, recursive invocation of a blocking C<< ->recv
		763	>> is not allowed, and the C<recv> call will C<croak> if such a
		764	condition is detected. This condition can be slightly loosened by using
		765	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		766	any thread that doesn't run the event loop itself.
		767
704	Not all event models support a blocking wait - some die in that case	768	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	769	(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	770	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	771	caller decide whether the call will block or not (for example, by coupling
708	condition variables with some kind of request results and supporting	772	condition variables with some kind of request results and supporting
709	callbacks so the caller knows that getting the result will not block,	773	callbacks so the caller knows that getting the result will not block,
710	while still supporting blocking waits if the caller so desires).	774	while still supporting blocking waits if the caller so desires).
711		775
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	776	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	777	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	778	time). This will work even when the event loop does not support blocking
726	waits otherwise.	779	waits otherwise.
727		780
…		…
740	variable itself. Calling C<recv> inside the callback or at any later time	793	variable itself. Calling C<recv> inside the callback or at any later time
741	is guaranteed not to block.	794	is guaranteed not to block.
742		795
743	=back	796	=back
744		797
		798	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		799
		800	The available backend classes are (every class has its own manpage):
		801
		802	=over 4
		803
		804	=item Backends that are autoprobed when no other event loop can be found.
		805
		806	EV is the preferred backend when no other event loop seems to be in
		807	use. If EV is not installed, then AnyEvent will try Event, and, failing
		808	that, will fall back to its own pure-perl implementation, which is
		809	available everywhere as it comes with AnyEvent itself.
		810
		811	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		812	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		813	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		814
		815	=item Backends that are transparently being picked up when they are used.
		816
		817	These will be used when they are currently loaded when the first watcher
		818	is created, in which case it is assumed that the application is using
		819	them. This means that AnyEvent will automatically pick the right backend
		820	when the main program loads an event module before anything starts to
		821	create watchers. Nothing special needs to be done by the main program.
		822
		823	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		824	AnyEvent::Impl::Tk based on Tk, very broken.
		825	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		826	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		827	AnyEvent::Impl::Irssi used when running within irssi.
		828
		829	=item Backends with special needs.
		830
		831	Qt requires the Qt::Application to be instantiated first, but will
		832	otherwise be picked up automatically. As long as the main program
		833	instantiates the application before any AnyEvent watchers are created,
		834	everything should just work.
		835
		836	AnyEvent::Impl::Qt based on Qt.
		837
		838	Support for IO::Async can only be partial, as it is too broken and
		839	architecturally limited to even support the AnyEvent API. It also
		840	is the only event loop that needs the loop to be set explicitly, so
		841	it can only be used by a main program knowing about AnyEvent. See
		842	L<AnyEvent::Impl::Async> for the gory details.
		843
		844	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		845
		846	=item Event loops that are indirectly supported via other backends.
		847
		848	Some event loops can be supported via other modules:
		849
		850	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		851
		852	B<WxWidgets> has no support for watching file handles. However, you can
		853	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		854	polls 20 times per second, which was considered to be too horrible to even
		855	consider for AnyEvent.
		856
		857	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		858	backend, so it can be supported through POE.
		859
		860	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		861	load L<POE> when detecting them, in the hope that POE will pick them up,
		862	in which case everything will be automatic.
		863
		864	=back
		865
745	=head1 GLOBAL VARIABLES AND FUNCTIONS	866	=head1 GLOBAL VARIABLES AND FUNCTIONS
746		867
		868	These are not normally required to use AnyEvent, but can be useful to
		869	write AnyEvent extension modules.
		870
747	=over 4	871	=over 4
748		872
749	=item $AnyEvent::MODEL	873	=item $AnyEvent::MODEL
750		874
751	Contains C<undef> until the first watcher is being created. Then it	875	Contains C<undef> until the first watcher is being created, before the
		876	backend has been autodetected.
		877
752	contains the event model that is being used, which is the name of the	878	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	879	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	880	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>).	881	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
756		882	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		883
782	=item AnyEvent::detect	884	=item AnyEvent::detect
783		885
784	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	886	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
785	if necessary. You should only call this function right before you would	887	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	888	have created an AnyEvent watcher anyway, that is, as late as possible at
787	runtime.	889	runtime, and not e.g. while initialising of your module.
		890
		891	If you need to do some initialisation before AnyEvent watchers are
		892	created, use C<post_detect>.
788		893
789	=item $guard = AnyEvent::post_detect { BLOCK }	894	=item $guard = AnyEvent::post_detect { BLOCK }
790		895
791	Arranges for the code block to be executed as soon as the event model is	896	Arranges for the code block to be executed as soon as the event model is
792	autodetected (or immediately if this has already happened).	897	autodetected (or immediately if this has already happened).
793		898
		899	The block will be executed I<after> the actual backend has been detected
		900	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		901	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		902	other initialisations - see the sources of L<AnyEvent::Strict> or
		903	L<AnyEvent::AIO> to see how this is used.
		904
		905	The most common usage is to create some global watchers, without forcing
		906	event module detection too early, for example, L<AnyEvent::AIO> creates
		907	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		908	avoid autodetecting the event module at load time.
		909
794	If called in scalar or list context, then it creates and returns an object	910	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	911	that automatically removes the callback again when it is destroyed (or
		912	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
796	L<Coro::BDB> for a case where this is useful.	913	a case where this is useful.
		914
		915	Example: Create a watcher for the IO::AIO module and store it in
		916	C<$WATCHER>. Only do so after the event loop is initialised, though.
		917
		918	our WATCHER;
		919
		920	my $guard = AnyEvent::post_detect {
		921	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		922	};
		923
		924	# the \|\|= is important in case post_detect immediately runs the block,
		925	# as to not clobber the newly-created watcher. assigning both watcher and
		926	# post_detect guard to the same variable has the advantage of users being
		927	# able to just C<undef $WATCHER> if the watcher causes them grief.
		928
		929	$WATCHER \|\|= $guard;
797		930
798	=item @AnyEvent::post_detect	931	=item @AnyEvent::post_detect
799		932
800	If there are any code references in this array (you can C<push> to it	933	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	934	before or after loading AnyEvent), then they will called directly after
802	the event loop has been chosen.	935	the event loop has been chosen.
803		936
804	You should check C<$AnyEvent::MODEL> before adding to this array, though:	937	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,	938	if it is defined then the event loop has already been detected, and the
806	and the array will be ignored.	939	array will be ignored.
807		940
808	Best use C<AnyEvent::post_detect { BLOCK }> instead.	941	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		942	it,as it takes care of these details.
		943
		944	This variable is mainly useful for modules that can do something useful
		945	when AnyEvent is used and thus want to know when it is initialised, but do
		946	not need to even load it by default. This array provides the means to hook
		947	into AnyEvent passively, without loading it.
809		948
810	=back	949	=back
811		950
812	=head1 WHAT TO DO IN A MODULE	951	=head1 WHAT TO DO IN A MODULE
813		952
…		…
868		1007
869		1008
870	=head1 OTHER MODULES	1009	=head1 OTHER MODULES
871		1010
872	The following is a non-exhaustive list of additional modules that use	1011	The following is a non-exhaustive list of additional modules that use
873	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1012	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
874	in the same program. Some of the modules come with AnyEvent, some are	1013	modules and other event loops in the same program. Some of the modules
875	available via CPAN.	1014	come with AnyEvent, most are available via CPAN.
876		1015
877	=over 4	1016	=over 4
878		1017
879	=item L<AnyEvent::Util>	1018	=item L<AnyEvent::Util>
880		1019
…		…
889		1028
890	=item L<AnyEvent::Handle>	1029	=item L<AnyEvent::Handle>
891		1030
892	Provide read and write buffers, manages watchers for reads and writes,	1031	Provide read and write buffers, manages watchers for reads and writes,
893	supports raw and formatted I/O, I/O queued and fully transparent and	1032	supports raw and formatted I/O, I/O queued and fully transparent and
894	non-blocking SSL/TLS.	1033	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
895		1034
896	=item L<AnyEvent::DNS>	1035	=item L<AnyEvent::DNS>
897		1036
898	Provides rich asynchronous DNS resolver capabilities.	1037	Provides rich asynchronous DNS resolver capabilities.
899		1038
…		…
927		1066
928	=item L<AnyEvent::GPSD>	1067	=item L<AnyEvent::GPSD>
929		1068
930	A non-blocking interface to gpsd, a daemon delivering GPS information.	1069	A non-blocking interface to gpsd, a daemon delivering GPS information.
931		1070
		1071	=item L<AnyEvent::IRC>
		1072
		1073	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1074
		1075	=item L<AnyEvent::XMPP>
		1076
		1077	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1078	Net::XMPP2>.
		1079
932	=item L<AnyEvent::IGS>	1080	=item L<AnyEvent::IGS>
933		1081
934	A non-blocking interface to the Internet Go Server protocol (used by	1082	A non-blocking interface to the Internet Go Server protocol (used by
935	L<App::IGS>).	1083	L<App::IGS>).
936		1084
937	=item L<AnyEvent::IRC>
938
939	AnyEvent based IRC client module family (replacing the older Net::IRC3).
940
941	=item L<Net::XMPP2>
942
943	AnyEvent based XMPP (Jabber protocol) module family.
944
945	=item L<Net::FCP>	1085	=item L<Net::FCP>
946		1086
947	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1087	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
948	of AnyEvent.	1088	of AnyEvent.
949		1089
…		…
953		1093
954	=item L<Coro>	1094	=item L<Coro>
955		1095
956	Has special support for AnyEvent via L<Coro::AnyEvent>.	1096	Has special support for AnyEvent via L<Coro::AnyEvent>.
957		1097
958	=item L<IO::Lambda>
959
960	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
961
962	=back	1098	=back
963		1099
964	=cut	1100	=cut
965		1101
966	package AnyEvent;	1102	package AnyEvent;
967		1103
		1104	# basically a tuned-down version of common::sense
		1105	sub common_sense {
968	no warnings;	1106	# no warnings
		1107	${^WARNING_BITS} ^= ${^WARNING_BITS};
969	use strict qw(vars subs);	1108	# use strict vars subs
		1109	$^H \|= 0x00000600;
		1110	}
970		1111
		1112	BEGIN { AnyEvent::common_sense }
		1113
971	use Carp;	1114	use Carp ();
972		1115
973	our $VERSION = 4.452;	1116	our $VERSION = 4.881;
974	our $MODEL;	1117	our $MODEL;
975		1118
976	our $AUTOLOAD;	1119	our $AUTOLOAD;
977	our @ISA;	1120	our @ISA;
978		1121
979	our @REGISTRY;	1122	our @REGISTRY;
980		1123
981	our $WIN32;	1124	our $WIN32;
		1125
		1126	our $VERBOSE;
982		1127
983	BEGIN {	1128	BEGIN {
984	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1129	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
985	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1130	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
986		1131
987	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1132	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
988	if ${^TAINT};	1133	if ${^TAINT};
989	}
990		1134
991	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1135	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1136
		1137	}
		1138
		1139	our $MAX_SIGNAL_LATENCY = 10;
992		1140
993	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1141	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
994		1142
995	{	1143	{
996	my $idx;	1144	my $idx;
…		…
998	for reverse split /\s,\s/,	1146	for reverse split /\s,\s/,
999	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1147	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1000	}	1148	}
1001		1149
1002	my @models = (	1150	my @models = (
1003	[EV:: => AnyEvent::Impl::EV::],	1151	[EV:: => AnyEvent::Impl::EV:: , 1],
1004	[Event:: => AnyEvent::Impl::Event::],	1152	[Event:: => AnyEvent::Impl::Event::, 1],
1005	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1153	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1006	# everything below here will not be autoprobed	1154	# everything below here will not (normally) be autoprobed
1007	# as the pureperl backend should work everywhere	1155	# as the pureperl backend should work everywhere
1008	# and is usually faster	1156	# and is usually faster
		1157	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1158	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1159	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1009	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1160	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1010	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1011	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1012	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1161	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1013	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1162	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1014	[Wx:: => AnyEvent::Impl::POE::],	1163	[Wx:: => AnyEvent::Impl::POE::],
1015	[Prima:: => AnyEvent::Impl::POE::],	1164	[Prima:: => AnyEvent::Impl::POE::],
1016	# IO::Async is just too broken - we would need workaorunds for its	1165	# IO::Async is just too broken - we would need workarounds for its
1017	# byzantine signal and broken child handling, among others.	1166	# byzantine signal and broken child handling, among others.
1018	# IO::Async is rather hard to detect, as it doesn't have any	1167	# IO::Async is rather hard to detect, as it doesn't have any
1019	# obvious default class.	1168	# obvious default class.
1020	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1169	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1021	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1170	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1022	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1171	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1023	);	1172	);
1024		1173
1025	our %method = map +($_ => 1),	1174	our %method = map +($_ => 1),
1026	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1175	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1027		1176
…		…
1031	my ($cb) = @_;	1180	my ($cb) = @_;
1032		1181
1033	if ($MODEL) {	1182	if ($MODEL) {
1034	$cb->();	1183	$cb->();
1035		1184
1036	1	1185	undef
1037	} else {	1186	} else {
1038	push @post_detect, $cb;	1187	push @post_detect, $cb;
1039		1188
1040	defined wantarray	1189	defined wantarray
1041	? bless \$cb, "AnyEvent::Util::postdetect"	1190	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1047	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1196	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1048	}	1197	}
1049		1198
1050	sub detect() {	1199	sub detect() {
1051	unless ($MODEL) {	1200	unless ($MODEL) {
1052	no strict 'refs';
1053	local $SIG{__DIE__};	1201	local $SIG{__DIE__};
1054		1202
1055	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1203	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1056	my $model = "AnyEvent::Impl::$1";	1204	my $model = "AnyEvent::Impl::$1";
1057	if (eval "require $model") {	1205	if (eval "require $model") {
1058	$MODEL = $model;	1206	$MODEL = $model;
1059	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1207	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1060	} else {	1208	} else {
1061	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1209	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1062	}	1210	}
1063	}	1211	}
1064		1212
1065	# check for already loaded models	1213	# check for already loaded models
1066	unless ($MODEL) {	1214	unless ($MODEL) {
1067	for (@REGISTRY, @models) {	1215	for (@REGISTRY, @models) {
1068	my ($package, $model) = @$_;	1216	my ($package, $model) = @$_;
1069	if (${"$package\::VERSION"} > 0) {	1217	if (${"$package\::VERSION"} > 0) {
1070	if (eval "require $model") {	1218	if (eval "require $model") {
1071	$MODEL = $model;	1219	$MODEL = $model;
1072	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1220	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1073	last;	1221	last;
1074	}	1222	}
1075	}	1223	}
1076	}	1224	}
1077		1225
1078	unless ($MODEL) {	1226	unless ($MODEL) {
1079	# try to load a model	1227	# try to autoload a model
1080
1081	for (@REGISTRY, @models) {	1228	for (@REGISTRY, @models) {
1082	my ($package, $model) = @$_;	1229	my ($package, $model, $autoload) = @$_;
		1230	if (
		1231	$autoload
1083	if (eval "require $package"	1232	and eval "require $package"
1084	and ${"$package\::VERSION"} > 0	1233	and ${"$package\::VERSION"} > 0
1085	and eval "require $model") {	1234	and eval "require $model"
		1235	) {
1086	$MODEL = $model;	1236	$MODEL = $model;
1087	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1237	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1088	last;	1238	last;
1089	}	1239	}
1090	}	1240	}
1091		1241
1092	$MODEL	1242	$MODEL
…		…
1108		1258
1109	sub AUTOLOAD {	1259	sub AUTOLOAD {
1110	(my $func = $AUTOLOAD) =~ s/.*://;	1260	(my $func = $AUTOLOAD) =~ s/.*://;
1111		1261
1112	$method{$func}	1262	$method{$func}
1113	or croak "$func: not a valid method for AnyEvent objects";	1263	or Carp::croak "$func: not a valid method for AnyEvent objects";
1114		1264
1115	detect unless $MODEL;	1265	detect unless $MODEL;
1116		1266
1117	my $class = shift;	1267	my $class = shift;
1118	$class->$func (@_);	1268	$class->$func (@_);
…		…
1123	# allow only one watcher per fd, so we dup it to get a different one).	1273	# allow only one watcher per fd, so we dup it to get a different one).
1124	sub _dupfh($$;$$) {	1274	sub _dupfh($$;$$) {
1125	my ($poll, $fh, $r, $w) = @_;	1275	my ($poll, $fh, $r, $w) = @_;
1126		1276
1127	# cygwin requires the fh mode to be matching, unix doesn't	1277	# cygwin requires the fh mode to be matching, unix doesn't
1128	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1278	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1129	: $poll eq "w" ? ($w, ">")
1130	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1131		1279
1132	open my $fh2, "$mode&" . fileno $fh	1280	open my $fh2, $mode, $fh
1133	or die "cannot dup() filehandle: $!,";	1281	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1134		1282
1135	# we assume CLOEXEC is already set by perl in all important cases	1283	# we assume CLOEXEC is already set by perl in all important cases
1136		1284
1137	($fh2, $rw)	1285	($fh2, $rw)
1138	}	1286	}
1139		1287
1140	package AnyEvent::Base;	1288	package AnyEvent::Base;
1141		1289
1142	# default implementations for many methods	1290	# default implementations for many methods
1143		1291
1144	BEGIN {	1292	sub _time {
		1293	# probe for availability of Time::HiRes
1145	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1294	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1295	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1146	*_time = \&Time::HiRes::time;	1296	*_time = \&Time::HiRes::time;
1147	# if (eval "use POSIX (); (POSIX::times())...	1297	# if (eval "use POSIX (); (POSIX::times())...
1148	} else {	1298	} else {
		1299	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1149	*_time = sub { time }; # epic fail	1300	*_time = sub { time }; # epic fail
1150	}	1301	}
		1302
		1303	&_time
1151	}	1304	}
1152		1305
1153	sub time { _time }	1306	sub time { _time }
1154	sub now { _time }	1307	sub now { _time }
1155	sub now_update { }	1308	sub now_update { }
…		…
1160	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1313	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1161	}	1314	}
1162		1315
1163	# default implementation for ->signal	1316	# default implementation for ->signal
1164		1317
		1318	our $HAVE_ASYNC_INTERRUPT;
		1319
		1320	sub _have_async_interrupt() {
		1321	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1322	&& eval "use Async::Interrupt 1.0 (); 1")
		1323	unless defined $HAVE_ASYNC_INTERRUPT;
		1324
		1325	$HAVE_ASYNC_INTERRUPT
		1326	}
		1327
1165	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1328	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1329	our (%SIG_ASY, %SIG_ASY_W);
		1330	our ($SIG_COUNT, $SIG_TW);
1166		1331
1167	sub _signal_exec {	1332	sub _signal_exec {
		1333	$HAVE_ASYNC_INTERRUPT
		1334	? $SIGPIPE_R->drain
1168	sysread $SIGPIPE_R, my $dummy, 4;	1335	: sysread $SIGPIPE_R, my $dummy, 9;
1169		1336
1170	while (%SIG_EV) {	1337	while (%SIG_EV) {
1171	for (keys %SIG_EV) {	1338	for (keys %SIG_EV) {
1172	delete $SIG_EV{$_};	1339	delete $SIG_EV{$_};
1173	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1340	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1174	}	1341	}
1175	}	1342	}
1176	}	1343	}
1177		1344
		1345	# install a dummy wakeup watcher to reduce signal catching latency
		1346	sub _sig_add() {
		1347	unless ($SIG_COUNT++) {
		1348	# try to align timer on a full-second boundary, if possible
		1349	my $NOW = AnyEvent->now;
		1350
		1351	$SIG_TW = AnyEvent->timer (
		1352	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1353	interval => $MAX_SIGNAL_LATENCY,
		1354	cb => sub { }, # just for the PERL_ASYNC_CHECK
		1355	);
		1356	}
		1357	}
		1358
		1359	sub _sig_del {
		1360	undef $SIG_TW
		1361	unless --$SIG_COUNT;
		1362	}
		1363
		1364	our $_sig_name_init; $_sig_name_init = sub {
		1365	eval q{ # poor man's autoloading
		1366	undef $_sig_name_init;
		1367
		1368	if (_have_async_interrupt) {
		1369	*sig2num = \&Async::Interrupt::sig2num;
		1370	*sig2name = \&Async::Interrupt::sig2name;
		1371	} else {
		1372	require Config;
		1373
		1374	my %signame2num;
		1375	@signame2num{ split ' ', $Config::Config{sig_name} }
		1376	= split ' ', $Config::Config{sig_num};
		1377
		1378	my @signum2name;
		1379	@signum2name[values %signame2num] = keys %signame2num;
		1380
		1381	*sig2num = sub($) {
		1382	$_[0] > 0 ? shift : $signame2num{+shift}
		1383	};
		1384	*sig2name = sub ($) {
		1385	$_[0] > 0 ? $signum2name[+shift] : shift
		1386	};
		1387	}
		1388	};
		1389	die if $@;
		1390	};
		1391
		1392	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1393	sub sig2name($) { &$_sig_name_init; &sig2name }
		1394
1178	sub signal {	1395	sub signal {
1179	my (undef, %arg) = @_;	1396	eval q{ # poor man's autoloading {}
		1397	# probe for availability of Async::Interrupt
		1398	if (_have_async_interrupt) {
		1399	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1180		1400
1181	unless ($SIGPIPE_R) {	1401	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1182	require Fcntl;	1402	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1183		1403
1184	if (AnyEvent::WIN32) {
1185	require AnyEvent::Util;
1186
1187	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1188	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1189	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1190	} else {	1404	} else {
		1405	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1406
		1407	require Fcntl;
		1408
		1409	if (AnyEvent::WIN32) {
		1410	require AnyEvent::Util;
		1411
		1412	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1413	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1414	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1415	} else {
1191	pipe $SIGPIPE_R, $SIGPIPE_W;	1416	pipe $SIGPIPE_R, $SIGPIPE_W;
1192	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1417	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1193	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1418	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1194		1419
1195	# not strictly required, as $^F is normally 2, but let's make sure...	1420	# not strictly required, as $^F is normally 2, but let's make sure...
1196	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1421	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1197	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1422	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1423	}
		1424
		1425	$SIGPIPE_R
		1426	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1427
		1428	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1198	}	1429	}
1199		1430
1200	$SIGPIPE_R	1431	*signal = sub {
1201	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1432	my (undef, %arg) = @_;
1202		1433
1203	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1204	}
1205
1206	my $signal = uc $arg{signal}	1434	my $signal = uc $arg{signal}
1207	or Carp::croak "required option 'signal' is missing";	1435	or Carp::croak "required option 'signal' is missing";
1208		1436
		1437	if ($HAVE_ASYNC_INTERRUPT) {
		1438	# async::interrupt
		1439
		1440	$signal = sig2num $signal;
1209	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1441	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1442
		1443	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1444	cb => sub { undef $SIG_EV{$signal} },
		1445	signal => $signal,
		1446	pipe => [$SIGPIPE_R->filenos],
		1447	pipe_autodrain => 0,
		1448	;
		1449
		1450	} else {
		1451	# pure perl
		1452
		1453	# AE::Util has been loaded in signal
		1454	$signal = sig2name $signal;
		1455	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1456
1210	$SIG{$signal} \|\|= sub {	1457	$SIG{$signal} \|\|= sub {
1211	local $!;	1458	local $!;
1212	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1459	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1213	undef $SIG_EV{$signal};	1460	undef $SIG_EV{$signal};
		1461	};
		1462
		1463	# can't do signal processing without introducing races in pure perl,
		1464	# so limit the signal latency.
		1465	_sig_add;
		1466	}
		1467
		1468	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1469	};
		1470
		1471	*AnyEvent::Base::signal::DESTROY = sub {
		1472	my ($signal, $cb) = @{$_[0]};
		1473
		1474	_sig_del;
		1475
		1476	delete $SIG_CB{$signal}{$cb};
		1477
		1478	$HAVE_ASYNC_INTERRUPT
		1479	? delete $SIG_ASY{$signal}
		1480	: # delete doesn't work with older perls - they then
		1481	# print weird messages, or just unconditionally exit
		1482	# instead of getting the default action.
		1483	undef $SIG{$signal}
		1484	unless keys %{ $SIG_CB{$signal} };
		1485	};
1214	};	1486	};
1215		1487	die if $@;
1216	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1488	&signal
1217	}
1218
1219	sub AnyEvent::Base::signal::DESTROY {
1220	my ($signal, $cb) = @{$_[0]};
1221
1222	delete $SIG_CB{$signal}{$cb};
1223
1224	# delete doesn't work with older perls - they then
1225	# print weird messages, or just unconditionally exit
1226	# instead of getting the default action.
1227	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1228	}	1489	}
1229		1490
1230	# default implementation for ->child	1491	# default implementation for ->child
1231		1492
1232	our %PID_CB;	1493	our %PID_CB;
1233	our $CHLD_W;	1494	our $CHLD_W;
1234	our $CHLD_DELAY_W;	1495	our $CHLD_DELAY_W;
1235	our $WNOHANG;	1496	our $WNOHANG;
1236		1497
		1498	sub _emit_childstatus($$) {
		1499	my (undef, $rpid, $rstatus) = @_;
		1500
		1501	$_->($rpid, $rstatus)
		1502	for values %{ $PID_CB{$rpid} \|\| {} },
		1503	values %{ $PID_CB{0} \|\| {} };
		1504	}
		1505
1237	sub _sigchld {	1506	sub _sigchld {
		1507	my $pid;
		1508
		1509	AnyEvent->_emit_childstatus ($pid, $?)
1238	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1510	while ($pid = waitpid -1, $WNOHANG) > 0;
1239	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
1240	(values %{ $PID_CB{0} \|\| {} });
1241	}
1242	}	1511	}
1243		1512
1244	sub child {	1513	sub child {
1245	my (undef, %arg) = @_;	1514	my (undef, %arg) = @_;
1246		1515
1247	defined (my $pid = $arg{pid} + 0)	1516	defined (my $pid = $arg{pid} + 0)
1248	or Carp::croak "required option 'pid' is missing";	1517	or Carp::croak "required option 'pid' is missing";
1249		1518
1250	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1519	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1251		1520
		1521	# WNOHANG is almost cetrainly 1 everywhere
		1522	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1523	? 1
1252	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1524	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1253		1525
1254	unless ($CHLD_W) {	1526	unless ($CHLD_W) {
1255	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1527	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1256	# child could be a zombie already, so make at least one round	1528	# child could be a zombie already, so make at least one round
1257	&_sigchld;	1529	&_sigchld;
…		…
1309		1581
1310	our @ISA = AnyEvent::CondVar::Base::;	1582	our @ISA = AnyEvent::CondVar::Base::;
1311		1583
1312	package AnyEvent::CondVar::Base;	1584	package AnyEvent::CondVar::Base;
1313		1585
1314	use overload	1586	#use overload
1315	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1587	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1316	fallback => 1;	1588	# fallback => 1;
		1589
		1590	# save 300+ kilobytes by dirtily hardcoding overloading
		1591	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1592	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1593	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1594	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1595
		1596	our $WAITING;
1317		1597
1318	sub _send {	1598	sub _send {
1319	# nop	1599	# nop
1320	}	1600	}
1321		1601
…		…
1334	sub ready {	1614	sub ready {
1335	$_[0]{_ae_sent}	1615	$_[0]{_ae_sent}
1336	}	1616	}
1337		1617
1338	sub _wait {	1618	sub _wait {
		1619	$WAITING
		1620	and !$_[0]{_ae_sent}
		1621	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1622
		1623	local $WAITING = 1;
1339	AnyEvent->one_event while !$_[0]{_ae_sent};	1624	AnyEvent->one_event while !$_[0]{_ae_sent};
1340	}	1625	}
1341		1626
1342	sub recv {	1627	sub recv {
1343	$_[0]->_wait;	1628	$_[0]->_wait;
…		…
1362	}	1647	}
1363		1648
1364	# undocumented/compatibility with pre-3.4	1649	# undocumented/compatibility with pre-3.4
1365	*broadcast = \&send;	1650	*broadcast = \&send;
1366	*wait = \&_wait;	1651	*wait = \&_wait;
		1652
		1653	#############################################################################
		1654	# "new" API, currently only emulation of it
		1655	#############################################################################
		1656
		1657	package AE;
		1658
		1659	sub io($$$) {
		1660	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1661	}
		1662
		1663	sub timer($$$) {
		1664	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
		1665	}
		1666
		1667	sub signal($$) {
		1668	AnyEvent->signal (signal => $_[0], cb => $_[1]);
		1669	}
		1670
		1671	sub child($$) {
		1672	AnyEvent->child (pid => $_[0], cb => $_[1]);
		1673	}
		1674
		1675	sub idle($) {
		1676	AnyEvent->idle (cb => $_[0]);
		1677	}
		1678
		1679	sub cv() {
		1680	AnyEvent->condvar
		1681	}
		1682
		1683	sub now() {
		1684	AnyEvent->now
		1685	}
		1686
		1687	sub now_update() {
		1688	AnyEvent->now_update
		1689	}
		1690
		1691	sub time() {
		1692	AnyEvent->time
		1693	}
1367		1694
1368	=head1 ERROR AND EXCEPTION HANDLING	1695	=head1 ERROR AND EXCEPTION HANDLING
1369		1696
1370	In general, AnyEvent does not do any error handling - it relies on the	1697	In general, AnyEvent does not do any error handling - it relies on the
1371	caller to do that if required. The L<AnyEvent::Strict> module (see also	1698	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1405	C<PERL_ANYEVENT_MODEL>.	1732	C<PERL_ANYEVENT_MODEL>.
1406		1733
1407	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1734	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1408	model it chooses.	1735	model it chooses.
1409		1736
		1737	When set to C<8> or higher, then AnyEvent will report extra information on
		1738	which optional modules it loads and how it implements certain features.
		1739
1410	=item C<PERL_ANYEVENT_STRICT>	1740	=item C<PERL_ANYEVENT_STRICT>
1411		1741
1412	AnyEvent does not do much argument checking by default, as thorough	1742	AnyEvent does not do much argument checking by default, as thorough
1413	argument checking is very costly. Setting this variable to a true value	1743	argument checking is very costly. Setting this variable to a true value
1414	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1744	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1415	check the arguments passed to most method calls. If it finds any problems,	1745	check the arguments passed to most method calls. If it finds any problems,
1416	it will croak.	1746	it will croak.
1417		1747
1418	In other words, enables "strict" mode.	1748	In other words, enables "strict" mode.
1419		1749
1420	Unlike C<use strict>, it is definitely recommended to keep it off in	1750	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1421	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1751	>>, it is definitely recommended to keep it off in production. Keeping
1422	developing programs can be very useful, however.	1752	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1753	can be very useful, however.
1423		1754
1424	=item C<PERL_ANYEVENT_MODEL>	1755	=item C<PERL_ANYEVENT_MODEL>
1425		1756
1426	This can be used to specify the event model to be used by AnyEvent, before	1757	This can be used to specify the event model to be used by AnyEvent, before
1427	auto detection and -probing kicks in. It must be a string consisting	1758	auto detection and -probing kicks in. It must be a string consisting
…		…
1470		1801
1471	=item C<PERL_ANYEVENT_MAX_FORKS>	1802	=item C<PERL_ANYEVENT_MAX_FORKS>
1472		1803
1473	The maximum number of child processes that C<AnyEvent::Util::fork_call>	1804	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1474	will create in parallel.	1805	will create in parallel.
		1806
		1807	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1808
		1809	The default value for the C<max_outstanding> parameter for the default DNS
		1810	resolver - this is the maximum number of parallel DNS requests that are
		1811	sent to the DNS server.
		1812
		1813	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1814
		1815	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1816	configuration) in the default resolver. When set to the empty string, no
		1817	default config will be used.
		1818
		1819	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1820
		1821	When neither C<ca_file> nor C<ca_path> was specified during
		1822	L<AnyEvent::TLS> context creation, and either of these environment
		1823	variables exist, they will be used to specify CA certificate locations
		1824	instead of a system-dependent default.
		1825
		1826	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1827
		1828	When these are set to C<1>, then the respective modules are not
		1829	loaded. Mostly good for testing AnyEvent itself.
1475		1830
1476	=back	1831	=back
1477		1832
1478	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1833	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1479		1834
…		…
2018		2373
2019	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2374	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2020	emulation for event loops that do not support them natively. Also, some	2375	emulation for event loops that do not support them natively. Also, some
2021	event loops install a similar handler.	2376	event loops install a similar handler.
2022		2377
2023	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will	2378	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2024	reset it to default, to avoid losing child exit statuses.	2379	AnyEvent will reset it to default, to avoid losing child exit statuses.
2025		2380
2026	=item SIGPIPE	2381	=item SIGPIPE
2027		2382
2028	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2383	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2029	when AnyEvent gets loaded.	2384	when AnyEvent gets loaded.
…		…
2047	if $SIG{CHLD} eq 'IGNORE';	2402	if $SIG{CHLD} eq 'IGNORE';
2048		2403
2049	$SIG{PIPE} = sub { }	2404	$SIG{PIPE} = sub { }
2050	unless defined $SIG{PIPE};	2405	unless defined $SIG{PIPE};
2051		2406
		2407	=head1 RECOMMENDED/OPTIONAL MODULES
		2408
		2409	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2410	it's built-in modules) are required to use it.
		2411
		2412	That does not mean that AnyEvent won't take advantage of some additional
		2413	modules if they are installed.
		2414
		2415	This section epxlains which additional modules will be used, and how they
		2416	affect AnyEvent's operetion.
		2417
		2418	=over 4
		2419
		2420	=item L<Async::Interrupt>
		2421
		2422	This slightly arcane module is used to implement fast signal handling: To
		2423	my knowledge, there is no way to do completely race-free and quick
		2424	signal handling in pure perl. To ensure that signals still get
		2425	delivered, AnyEvent will start an interval timer to wake up perl (and
		2426	catch the signals) with some delay (default is 10 seconds, look for
		2427	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2428
		2429	If this module is available, then it will be used to implement signal
		2430	catching, which means that signals will not be delayed, and the event loop
		2431	will not be interrupted regularly, which is more efficient (And good for
		2432	battery life on laptops).
		2433
		2434	This affects not just the pure-perl event loop, but also other event loops
		2435	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2436
		2437	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2438	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2439	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2440	does nothing for those backends.
		2441
		2442	=item L<EV>
		2443
		2444	This module isn't really "optional", as it is simply one of the backend
		2445	event loops that AnyEvent can use. However, it is simply the best event
		2446	loop available in terms of features, speed and stability: It supports
		2447	the AnyEvent API optimally, implements all the watcher types in XS, does
		2448	automatic timer adjustments even when no monotonic clock is available,
		2449	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2450	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2451	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2452
		2453	=item L<Guard>
		2454
		2455	The guard module, when used, will be used to implement
		2456	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2457	lot less memory), but otherwise doesn't affect guard operation much. It is
		2458	purely used for performance.
		2459
		2460	=item L<JSON> and L<JSON::XS>
		2461
		2462	This module is required when you want to read or write JSON data via
		2463	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2464	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2465
		2466	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2467	installed.
		2468
		2469	=item L<Net::SSLeay>
		2470
		2471	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2472	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2473	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2474
		2475	=item L<Time::HiRes>
		2476
		2477	This module is part of perl since release 5.008. It will be used when the
		2478	chosen event library does not come with a timing source on it's own. The
		2479	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2480	try to use a monotonic clock for timing stability.
		2481
		2482	=back
		2483
		2484
2052	=head1 FORK	2485	=head1 FORK
2053		2486
2054	Most event libraries are not fork-safe. The ones who are usually are	2487	Most event libraries are not fork-safe. The ones who are usually are
2055	because they rely on inefficient but fork-safe C<select> or C<poll>	2488	because they rely on inefficient but fork-safe C<select> or C<poll>
2056	calls. Only L<EV> is fully fork-aware.	2489	calls. Only L<EV> is fully fork-aware.
2057		2490
2058	If you have to fork, you must either do so I<before> creating your first	2491	If you have to fork, you must either do so I<before> creating your first
2059	watcher OR you must not use AnyEvent at all in the child.	2492	watcher OR you must not use AnyEvent at all in the child OR you must do
		2493	something completely out of the scope of AnyEvent.
2060		2494
2061		2495
2062	=head1 SECURITY CONSIDERATIONS	2496	=head1 SECURITY CONSIDERATIONS
2063		2497
2064	AnyEvent can be forced to load any event model via	2498	AnyEvent can be forced to load any event model via
…		…
2102	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2536	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2103		2537
2104	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2538	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2105	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2539	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2106	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2540	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2107	L<AnyEvent::Impl::POE>.	2541	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2108		2542
2109	Non-blocking file handles, sockets, TCP clients and	2543	Non-blocking file handles, sockets, TCP clients and
2110	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2544	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2111		2545
2112	Asynchronous DNS: L<AnyEvent::DNS>.	2546	Asynchronous DNS: L<AnyEvent::DNS>.
2113		2547
2114	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2548	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2549	L<Coro::Event>,
2115		2550
2116	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2551	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2552	L<AnyEvent::HTTP>.
2117		2553
2118		2554
2119	=head1 AUTHOR	2555	=head1 AUTHOR
2120		2556
2121	Marc Lehmann <schmorp@schmorp.de>	2557	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.224 by root, Fri Jul 3 21:44:14 2009 UTC vs. Revision 1.266 by root, Thu Jul 30 03:41:56 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.224 by root, Fri Jul 3 21:44:14 2009 UTC vs.
Revision 1.266 by root, Thu Jul 30 03:41:56 2009 UTC