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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.234 by root, Thu Jul 9 08:31:16 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
745	=head1 SUPPORTED EVENT LOOPS/BACKENDS	802	=head1 SUPPORTED EVENT LOOPS/BACKENDS
746		803
…		…
769		826
770	AnyEvent::Impl::Glib based on Glib, slow but very stable.	827	AnyEvent::Impl::Glib based on Glib, slow but very stable.
771	AnyEvent::Impl::Tk based on Tk, very broken.	828	AnyEvent::Impl::Tk based on Tk, very broken.
772	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
773	AnyEvent::Impl::POE based on POE, very slow, some limitations.	830	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		831	AnyEvent::Impl::Irssi used when running within irssi.
774		832
775	=item Backends with special needs.	833	=item Backends with special needs.
776		834
777	Qt requires the Qt::Application to be instantiated first, but will	835	Qt requires the Qt::Application to be instantiated first, but will
778	otherwise be picked up automatically. As long as the main program	836	otherwise be picked up automatically. As long as the main program
…		…
852	event module detection too early, for example, L<AnyEvent::AIO> creates	910	event module detection too early, for example, L<AnyEvent::AIO> creates
853	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	911	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
854	avoid autodetecting the event module at load time.	912	avoid autodetecting the event module at load time.
855		913
856	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
857	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
858	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;
859		934
860	=item @AnyEvent::post_detect	935	=item @AnyEvent::post_detect
861		936
862	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
863	before or after loading AnyEvent), then they will called directly after	938	before or after loading AnyEvent), then they will called directly after
…		…
1028		1103
1029	=cut	1104	=cut
1030		1105
1031	package AnyEvent;	1106	package AnyEvent;
1032		1107
		1108	# basically a tuned-down version of common::sense
		1109	sub common_sense {
1033	no warnings;	1110	# no warnings
		1111	${^WARNING_BITS} ^= ${^WARNING_BITS};
1034	use strict qw(vars subs);	1112	# use strict vars subs
		1113	$^H \|= 0x00000600;
		1114	}
1035		1115
		1116	BEGIN { AnyEvent::common_sense }
		1117
1036	use Carp;	1118	use Carp ();
1037		1119
1038	our $VERSION = 4.81;	1120	our $VERSION = 4.9;
1039	our $MODEL;	1121	our $MODEL;
1040		1122
1041	our $AUTOLOAD;	1123	our $AUTOLOAD;
1042	our @ISA;	1124	our @ISA;
1043		1125
1044	our @REGISTRY;	1126	our @REGISTRY;
1045		1127
1046	our $WIN32;	1128	our $WIN32;
		1129
		1130	our $VERBOSE;
1047		1131
1048	BEGIN {	1132	BEGIN {
1049	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1050	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1051		1135
1052	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1053	if ${^TAINT};	1137	if ${^TAINT};
1054	}
1055		1138
1056	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1140
		1141	}
		1142
		1143	our $MAX_SIGNAL_LATENCY = 10;
1057		1144
1058	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1145	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
1059		1146
1060	{	1147	{
1061	my $idx;	1148	my $idx;
…		…
1063	for reverse split /\s,\s/,	1150	for reverse split /\s,\s/,
1064	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1065	}	1152	}
1066		1153
1067	my @models = (	1154	my @models = (
1068	[EV:: => AnyEvent::Impl::EV::],	1155	[EV:: => AnyEvent::Impl::EV:: , 1],
1069	[Event:: => AnyEvent::Impl::Event::],	1156	[Event:: => AnyEvent::Impl::Event::, 1],
1070	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1071	# everything below here will not be autoprobed	1158	# everything below here will not (normally) be autoprobed
1072	# as the pureperl backend should work everywhere	1159	# as the pureperl backend should work everywhere
1073	# and is usually faster	1160	# and is usually faster
1074	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1075	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1076	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1077	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1078	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1079	[Wx:: => AnyEvent::Impl::POE::],	1167	[Wx:: => AnyEvent::Impl::POE::],
1080	[Prima:: => AnyEvent::Impl::POE::],	1168	[Prima:: => AnyEvent::Impl::POE::],
1081	# IO::Async is just too broken - we would need workarounds for its	1169	# IO::Async is just too broken - we would need workarounds for its
1082	# byzantine signal and broken child handling, among others.	1170	# byzantine signal and broken child handling, among others.
1083	# 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
1084	# obvious default class.	1172	# obvious default class.
1085	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1086	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1087	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1088	);	1176	);
1089		1177
1090	our %method = map +($_ => 1),	1178	our %method = map +($_ => 1),
1091	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);
1092		1180
…		…
1096	my ($cb) = @_;	1184	my ($cb) = @_;
1097		1185
1098	if ($MODEL) {	1186	if ($MODEL) {
1099	$cb->();	1187	$cb->();
1100		1188
1101	1	1189	undef
1102	} else {	1190	} else {
1103	push @post_detect, $cb;	1191	push @post_detect, $cb;
1104		1192
1105	defined wantarray	1193	defined wantarray
1106	? bless \$cb, "AnyEvent::Util::postdetect"	1194	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1112	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1200	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1113	}	1201	}
1114		1202
1115	sub detect() {	1203	sub detect() {
1116	unless ($MODEL) {	1204	unless ($MODEL) {
1117	no strict 'refs';
1118	local $SIG{__DIE__};	1205	local $SIG{__DIE__};
1119		1206
1120	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1207	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1121	my $model = "AnyEvent::Impl::$1";	1208	my $model = "AnyEvent::Impl::$1";
1122	if (eval "require $model") {	1209	if (eval "require $model") {
1123	$MODEL = $model;	1210	$MODEL = $model;
1124	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;
1125	} else {	1212	} else {
1126	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;
1127	}	1214	}
1128	}	1215	}
1129		1216
1130	# check for already loaded models	1217	# check for already loaded models
1131	unless ($MODEL) {	1218	unless ($MODEL) {
1132	for (@REGISTRY, @models) {	1219	for (@REGISTRY, @models) {
1133	my ($package, $model) = @$_;	1220	my ($package, $model) = @$_;
1134	if (${"$package\::VERSION"} > 0) {	1221	if (${"$package\::VERSION"} > 0) {
1135	if (eval "require $model") {	1222	if (eval "require $model") {
1136	$MODEL = $model;	1223	$MODEL = $model;
1137	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1224	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1138	last;	1225	last;
1139	}	1226	}
1140	}	1227	}
1141	}	1228	}
1142		1229
1143	unless ($MODEL) {	1230	unless ($MODEL) {
1144	# try to load a model	1231	# try to autoload a model
1145
1146	for (@REGISTRY, @models) {	1232	for (@REGISTRY, @models) {
1147	my ($package, $model) = @$_;	1233	my ($package, $model, $autoload) = @$_;
		1234	if (
		1235	$autoload
1148	if (eval "require $package"	1236	and eval "require $package"
1149	and ${"$package\::VERSION"} > 0	1237	and ${"$package\::VERSION"} > 0
1150	and eval "require $model") {	1238	and eval "require $model"
		1239	) {
1151	$MODEL = $model;	1240	$MODEL = $model;
1152	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1241	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1153	last;	1242	last;
1154	}	1243	}
1155	}	1244	}
1156		1245
1157	$MODEL	1246	$MODEL
…		…
1173		1262
1174	sub AUTOLOAD {	1263	sub AUTOLOAD {
1175	(my $func = $AUTOLOAD) =~ s/.*://;	1264	(my $func = $AUTOLOAD) =~ s/.*://;
1176		1265
1177	$method{$func}	1266	$method{$func}
1178	or croak "$func: not a valid method for AnyEvent objects";	1267	or Carp::croak "$func: not a valid method for AnyEvent objects";
1179		1268
1180	detect unless $MODEL;	1269	detect unless $MODEL;
1181		1270
1182	my $class = shift;	1271	my $class = shift;
1183	$class->$func (@_);	1272	$class->$func (@_);
…		…
1188	# 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).
1189	sub _dupfh($$;$$) {	1278	sub _dupfh($$;$$) {
1190	my ($poll, $fh, $r, $w) = @_;	1279	my ($poll, $fh, $r, $w) = @_;
1191		1280
1192	# cygwin requires the fh mode to be matching, unix doesn't	1281	# cygwin requires the fh mode to be matching, unix doesn't
1193	my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">");	1282	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1194		1283
1195	open my $fh2, "$mode&", $fh	1284	open my $fh2, $mode, $fh
1196	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";	1285	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1197		1286
1198	# 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
1199		1288
1200	($fh2, $rw)	1289	($fh2, $rw)
…		…
1202		1291
1203	package AnyEvent::Base;	1292	package AnyEvent::Base;
1204		1293
1205	# default implementations for many methods	1294	# default implementations for many methods
1206		1295
1207	BEGIN {	1296	sub _time {
		1297	# probe for availability of Time::HiRes
1208	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;
1209	*_time = \&Time::HiRes::time;	1300	*_time = \&Time::HiRes::time;
1210	# if (eval "use POSIX (); (POSIX::times())...	1301	# if (eval "use POSIX (); (POSIX::times())...
1211	} else {	1302	} else {
		1303	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1212	*_time = sub { time }; # epic fail	1304	*_time = sub { time }; # epic fail
1213	}	1305	}
		1306
		1307	&_time
1214	}	1308	}
1215		1309
1216	sub time { _time }	1310	sub time { _time }
1217	sub now { _time }	1311	sub now { _time }
1218	sub now_update { }	1312	sub now_update { }
…		…
1223	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1317	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1224	}	1318	}
1225		1319
1226	# default implementation for ->signal	1320	# default implementation for ->signal
1227		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
1228	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);
1229		1335
1230	sub _signal_exec {	1336	sub _signal_exec {
		1337	$HAVE_ASYNC_INTERRUPT
		1338	? $SIGPIPE_R->drain
1231	sysread $SIGPIPE_R, my $dummy, 4;	1339	: sysread $SIGPIPE_R, my $dummy, 9;
1232		1340
1233	while (%SIG_EV) {	1341	while (%SIG_EV) {
1234	for (keys %SIG_EV) {	1342	for (keys %SIG_EV) {
1235	delete $SIG_EV{$_};	1343	delete $SIG_EV{$_};
1236	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1344	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1237	}	1345	}
1238	}	1346	}
1239	}	1347	}
1240		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
1241	sub signal {	1399	sub signal {
1242	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;
1243		1404
1244	unless ($SIGPIPE_R) {	1405	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1245	require Fcntl;	1406	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1246		1407
1247	if (AnyEvent::WIN32) {
1248	require AnyEvent::Util;
1249
1250	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1251	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1252	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1253	} 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 {
1254	pipe $SIGPIPE_R, $SIGPIPE_W;	1420	pipe $SIGPIPE_R, $SIGPIPE_W;
1255	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;
1256	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
1257		1423
1258	# 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...
1259	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1425	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1260	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);
1261	}	1433	}
1262		1434
1263	$SIGPIPE_R	1435	*signal = sub {
1264	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1436	my (undef, %arg) = @_;
1265		1437
1266	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1267	}
1268
1269	my $signal = uc $arg{signal}	1438	my $signal = uc $arg{signal}
1270	or Carp::croak "required option 'signal' is missing";	1439	or Carp::croak "required option 'signal' is missing";
1271		1440
		1441	if ($HAVE_ASYNC_INTERRUPT) {
		1442	# async::interrupt
		1443
		1444	$signal = sig2num $signal;
1272	$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
1273	$SIG{$signal} \|\|= sub {	1461	$SIG{$signal} \|\|= sub {
1274	local $!;	1462	local $!;
1275	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1463	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1276	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	};
1277	};	1490	};
1278		1491	die if $@;
1279	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1492	&signal
1280	}
1281
1282	sub AnyEvent::Base::signal::DESTROY {
1283	my ($signal, $cb) = @{$_[0]};
1284
1285	delete $SIG_CB{$signal}{$cb};
1286
1287	# delete doesn't work with older perls - they then
1288	# print weird messages, or just unconditionally exit
1289	# instead of getting the default action.
1290	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1291	}	1493	}
1292		1494
1293	# default implementation for ->child	1495	# default implementation for ->child
1294		1496
1295	our %PID_CB;	1497	our %PID_CB;
1296	our $CHLD_W;	1498	our $CHLD_W;
1297	our $CHLD_DELAY_W;	1499	our $CHLD_DELAY_W;
1298	our $WNOHANG;	1500	our $WNOHANG;
1299		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
1300	sub _sigchld {	1510	sub _sigchld {
		1511	my $pid;
		1512
		1513	AnyEvent->_emit_childstatus ($pid, $?)
1301	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1514	while ($pid = waitpid -1, $WNOHANG) > 0;
1302	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
1303	(values %{ $PID_CB{0} \|\| {} });
1304	}
1305	}	1515	}
1306		1516
1307	sub child {	1517	sub child {
1308	my (undef, %arg) = @_;	1518	my (undef, %arg) = @_;
1309		1519
1310	defined (my $pid = $arg{pid} + 0)	1520	defined (my $pid = $arg{pid} + 0)
1311	or Carp::croak "required option 'pid' is missing";	1521	or Carp::croak "required option 'pid' is missing";
1312		1522
1313	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1523	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1314		1524
		1525	# WNOHANG is almost cetrainly 1 everywhere
		1526	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1527	? 1
1315	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1528	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1316		1529
1317	unless ($CHLD_W) {	1530	unless ($CHLD_W) {
1318	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1531	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1319	# 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
1320	&_sigchld;	1533	&_sigchld;
…		…
1372		1585
1373	our @ISA = AnyEvent::CondVar::Base::;	1586	our @ISA = AnyEvent::CondVar::Base::;
1374		1587
1375	package AnyEvent::CondVar::Base;	1588	package AnyEvent::CondVar::Base;
1376		1589
1377	use overload	1590	#use overload
1378	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1591	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1379	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;
1380		1601
1381	sub _send {	1602	sub _send {
1382	# nop	1603	# nop
1383	}	1604	}
1384		1605
…		…
1397	sub ready {	1618	sub ready {
1398	$_[0]{_ae_sent}	1619	$_[0]{_ae_sent}
1399	}	1620	}
1400		1621
1401	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;
1402	AnyEvent->one_event while !$_[0]{_ae_sent};	1628	AnyEvent->one_event while !$_[0]{_ae_sent};
1403	}	1629	}
1404		1630
1405	sub recv {	1631	sub recv {
1406	$_[0]->_wait;	1632	$_[0]->_wait;
…		…
1408	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1634	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1409	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1635	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1410	}	1636	}
1411		1637
1412	sub cb {	1638	sub cb {
1413	$_[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);
1414	$_[0]{_ae_cb}	1645	$cv->{_ae_cb}
1415	}	1646	}
1416		1647
1417	sub begin {	1648	sub begin {
1418	++$_[0]{_ae_counter};	1649	++$_[0]{_ae_counter};
1419	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1650	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1425	}	1656	}
1426		1657
1427	# undocumented/compatibility with pre-3.4	1658	# undocumented/compatibility with pre-3.4
1428	*broadcast = \&send;	1659	*broadcast = \&send;
1429	*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	}
1430		1703
1431	=head1 ERROR AND EXCEPTION HANDLING	1704	=head1 ERROR AND EXCEPTION HANDLING
1432		1705
1433	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
1434	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
…		…
1468	C<PERL_ANYEVENT_MODEL>.	1741	C<PERL_ANYEVENT_MODEL>.
1469		1742
1470	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
1471	model it chooses.	1744	model it chooses.
1472		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
1473	=item C<PERL_ANYEVENT_STRICT>	1749	=item C<PERL_ANYEVENT_STRICT>
1474		1750
1475	AnyEvent does not do much argument checking by default, as thorough	1751	AnyEvent does not do much argument checking by default, as thorough
1476	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
1477	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
1478	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,
1479	it will croak.	1755	it will croak.
1480		1756
1481	In other words, enables "strict" mode.	1757	In other words, enables "strict" mode.
1482		1758
1483	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>
1484	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1760	>>, it is definitely recommended to keep it off in production. Keeping
1485	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.
1486		1763
1487	=item C<PERL_ANYEVENT_MODEL>	1764	=item C<PERL_ANYEVENT_MODEL>
1488		1765
1489	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
1490	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
…		…
1552		1829
1553	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
1554	L<AnyEvent::TLS> context creation, and either of these environment	1831	L<AnyEvent::TLS> context creation, and either of these environment
1555	variables exist, they will be used to specify CA certificate locations	1832	variables exist, they will be used to specify CA certificate locations
1556	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.
1557		1839
1558	=back	1840	=back
1559		1841
1560	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1842	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1561		1843
…		…
2100		2382
2101	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
2102	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
2103	event loops install a similar handler.	2385	event loops install a similar handler.
2104		2386
2105	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
2106	reset it to default, to avoid losing child exit statuses.	2388	AnyEvent will reset it to default, to avoid losing child exit statuses.
2107		2389
2108	=item SIGPIPE	2390	=item SIGPIPE
2109		2391
2110	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>
2111	when AnyEvent gets loaded.	2393	when AnyEvent gets loaded.
…		…
2129	if $SIG{CHLD} eq 'IGNORE';	2411	if $SIG{CHLD} eq 'IGNORE';
2130		2412
2131	$SIG{PIPE} = sub { }	2413	$SIG{PIPE} = sub { }
2132	unless defined $SIG{PIPE};	2414	unless defined $SIG{PIPE};
2133		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
2134	=head1 FORK	2494	=head1 FORK
2135		2495
2136	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
2137	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>
2138	calls. Only L<EV> is fully fork-aware.	2498	calls. Only L<EV> is fully fork-aware.
2139		2499
2140	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
2141	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.
2142		2503
2143		2504
2144	=head1 SECURITY CONSIDERATIONS	2505	=head1 SECURITY CONSIDERATIONS
2145		2506
2146	AnyEvent can be forced to load any event model via	2507	AnyEvent can be forced to load any event model via
…		…
2184	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2545	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2185		2546
2186	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2547	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2187	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>,
2188	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2549	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2189	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2550	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2190		2551
2191	Non-blocking file handles, sockets, TCP clients and	2552	Non-blocking file handles, sockets, TCP clients and
2192	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2553	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2193		2554
2194	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.234 by root, Thu Jul 9 08:31:16 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.234 by root, Thu Jul 9 08:31:16 2009 UTC vs.
Revision 1.269 by root, Fri Jul 31 20:16:29 2009 UTC