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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs.
Revision 1.276 by root, Sun Aug 9 10:53:33 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - events independent of event loop implementation	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
47		47
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	48	There is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	49	channel, too.
50		50
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Respository>, at L<http://anyevent.schmorp.de>, for more info.	52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		53
54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55		55
56	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
57	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
181	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
182	declared.	182	declared.
183		183
184	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
185		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
186	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
187	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
188		194
189	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
190	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
…		…
219	undef $w;	225	undef $w;
220	});	226	});
221		227
222	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
223		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
224	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 >>
225	method with the following mandatory arguments:	239	method with the following mandatory arguments:
226		240
227	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
228	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
…		…
355		369
356	=back	370	=back
357		371
358	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
359		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		375
360	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
361	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
362	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
363		379
364	Although the callback might get passed parameters, their value and	380	Although the callback might get passed parameters, their value and
…		…
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		400
385	=head3 Signal Races, Delays and Workarounds	401	=head3 Signal Races, Delays and Workarounds
386		402
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388	callbacks to signals in a generic way, which is a pity, as you cannot do	404	callbacks to signals in a generic way, which is a pity, as you cannot
389	race-free signal handling in perl. AnyEvent will try to do it's best, but	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,
390	in some cases, signals will be delayed. The maximum time a signal might	407	signals will be delayed. The maximum time a signal might be delayed is
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	409	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	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
394	will cause fewer spurious wake-ups, which is better for power and CPU	412	will cause fewer spurious wake-ups, which is better for power and CPU
		413	saving.
		414
395	saving. All these problems can be avoided by installing the optional	415	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	416	L<Async::Interrupt> module, which works with most event loops. It will not
397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	417	work with inherently broken event loops such as L<Event> or L<Event::Lib>
398	currently, as POE does it's own workaround with one-second latency). With	418	(and not with L<POE> currently, as POE does it's own workaround with
399	those, you just have to suffer the delays.	419	one-second latency). For those, you just have to suffer the delays.
400		420
401	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
402		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
403	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.
404		426
405	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,
406	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
407	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
408	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
409		432
410	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
411	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
412	callback arguments.	435	callback arguments.
413		436
…		…
454	# do something else, then wait for process exit	477	# do something else, then wait for process exit
455	$done->recv;	478	$done->recv;
456		479
457	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
458		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
459	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
460	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
461	"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
462	attention by the event loop".	487	attention by the event loop".
463		488
…		…
489	});	514	});
490	});	515	});
491		516
492	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
493		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
494	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
495	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
496	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
497		527
498	AnyEvent is slightly different: it expects somebody else to run the event	528	AnyEvent is slightly different: it expects somebody else to run the event
…		…
517	Condition variables are similar to callbacks, except that you can	547	Condition variables are similar to callbacks, except that you can
518	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
519	in time where multiple outstanding events have been processed. And yet	549	in time where multiple outstanding events have been processed. And yet
520	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
521	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
522	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.
523		554
524	Condition variables are very useful to signal that something has finished,	555	Condition variables are very useful to signal that something has finished,
525	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,
526	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
527	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
…		…
759	=item $cb = $cv->cb ($cb->($cv))	790	=item $cb = $cv->cb ($cb->($cv))
760		791
761	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
762	replaces it before doing so.	793	replaces it before doing so.
763		794
764	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)
765	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
766	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>
767	is guaranteed not to block.	798	inside the callback or at any later time is guaranteed not to block.
768		799
769	=back	800	=back
770		801
771	=head1 SUPPORTED EVENT LOOPS/BACKENDS	802	=head1 SUPPORTED EVENT LOOPS/BACKENDS
772		803
…		…
775	=over 4	806	=over 4
776		807
777	=item Backends that are autoprobed when no other event loop can be found.	808	=item Backends that are autoprobed when no other event loop can be found.
778		809
779	EV is the preferred backend when no other event loop seems to be in	810	EV is the preferred backend when no other event loop seems to be in
780	use. If EV is not installed, then AnyEvent will try Event, and, failing	811	use. If EV is not installed, then AnyEvent will fall back to its own
781	that, will fall back to its own pure-perl implementation, which is	812	pure-perl implementation, which is available everywhere as it comes with
782	available everywhere as it comes with AnyEvent itself.	813	AnyEvent itself.
783		814
784	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
785	AnyEvent::Impl::Event based on Event, very stable, few glitches.
786	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	816	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
787		817
788	=item Backends that are transparently being picked up when they are used.	818	=item Backends that are transparently being picked up when they are used.
789		819
790	These will be used when they are currently loaded when the first watcher	820	These will be used when they are currently loaded when the first watcher
791	is created, in which case it is assumed that the application is using	821	is created, in which case it is assumed that the application is using
792	them. This means that AnyEvent will automatically pick the right backend	822	them. This means that AnyEvent will automatically pick the right backend
793	when the main program loads an event module before anything starts to	823	when the main program loads an event module before anything starts to
794	create watchers. Nothing special needs to be done by the main program.	824	create watchers. Nothing special needs to be done by the main program.
795		825
		826	AnyEvent::Impl::Event based on Event, very stable, few glitches.
796	AnyEvent::Impl::Glib based on Glib, slow but very stable.	827	AnyEvent::Impl::Glib based on Glib, slow but very stable.
797	AnyEvent::Impl::Tk based on Tk, very broken.	828	AnyEvent::Impl::Tk based on Tk, very broken.
798	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
799	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.
800		832
801	=item Backends with special needs.	833	=item Backends with special needs.
802		834
803	Qt requires the Qt::Application to be instantiated first, but will	835	Qt requires the Qt::Application to be instantiated first, but will
804	otherwise be picked up automatically. As long as the main program	836	otherwise be picked up automatically. As long as the main program
…		…
878	event module detection too early, for example, L<AnyEvent::AIO> creates	910	event module detection too early, for example, L<AnyEvent::AIO> creates
879	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
880	avoid autodetecting the event module at load time.	912	avoid autodetecting the event module at load time.
881		913
882	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
883	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
884	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;
885		934
886	=item @AnyEvent::post_detect	935	=item @AnyEvent::post_detect
887		936
888	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
889	before or after loading AnyEvent), then they will called directly after	938	before or after loading AnyEvent), then they will called directly after
…		…
1066		1115
1067	BEGIN { AnyEvent::common_sense }	1116	BEGIN { AnyEvent::common_sense }
1068		1117
1069	use Carp ();	1118	use Carp ();
1070		1119
1071	our $VERSION = 4.85;	1120	our $VERSION = 4.92;
1072	our $MODEL;	1121	our $MODEL;
1073		1122
1074	our $AUTOLOAD;	1123	our $AUTOLOAD;
1075	our @ISA;	1124	our @ISA;
1076		1125
…		…
1101	for reverse split /\s,\s/,	1150	for reverse split /\s,\s/,
1102	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1103	}	1152	}
1104		1153
1105	my @models = (	1154	my @models = (
1106	[EV:: => AnyEvent::Impl::EV::],	1155	[EV:: => AnyEvent::Impl::EV:: , 1],
1107	[Event:: => AnyEvent::Impl::Event::],
1108	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1156	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1109	# everything below here will not be autoprobed	1157	# everything below here will not (normally) be autoprobed
1110	# as the pureperl backend should work everywhere	1158	# as the pureperl backend should work everywhere
1111	# and is usually faster	1159	# and is usually faster
		1160	[Event:: => AnyEvent::Impl::Event::, 1],
1112	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1113	[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
1114	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1115	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1116	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1117	[Wx:: => AnyEvent::Impl::POE::],	1167	[Wx:: => AnyEvent::Impl::POE::],
1118	[Prima:: => AnyEvent::Impl::POE::],	1168	[Prima:: => AnyEvent::Impl::POE::],
1119	# 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
1120	# byzantine signal and broken child handling, among others.	1170	# byzantine signal and broken child handling, among others.
1121	# 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
1122	# obvious default class.	1172	# obvious default class.
1123	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1124	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1126	);	1176	);
1127		1177
1128	our %method = map +($_ => 1),	1178	our %method = map +($_ => 1),
1129	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);
1130		1180
…		…
1134	my ($cb) = @_;	1184	my ($cb) = @_;
1135		1185
1136	if ($MODEL) {	1186	if ($MODEL) {
1137	$cb->();	1187	$cb->();
1138		1188
1139	1	1189	undef
1140	} else {	1190	} else {
1141	push @post_detect, $cb;	1191	push @post_detect, $cb;
1142		1192
1143	defined wantarray	1193	defined wantarray
1144	? bless \$cb, "AnyEvent::Util::postdetect"	1194	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1176	}	1226	}
1177	}	1227	}
1178	}	1228	}
1179		1229
1180	unless ($MODEL) {	1230	unless ($MODEL) {
1181	# try to load a model	1231	# try to autoload a model
1182
1183	for (@REGISTRY, @models) {	1232	for (@REGISTRY, @models) {
1184	my ($package, $model) = @$_;	1233	my ($package, $model, $autoload) = @$_;
		1234	if (
		1235	$autoload
1185	if (eval "require $package"	1236	and eval "require $package"
1186	and ${"$package\::VERSION"} > 0	1237	and ${"$package\::VERSION"} > 0
1187	and eval "require $model") {	1238	and eval "require $model"
		1239	) {
1188	$MODEL = $model;	1240	$MODEL = $model;
1189	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1241	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1190	last;	1242	last;
1191	}	1243	}
1192	}	1244	}
1193		1245
1194	$MODEL	1246	$MODEL
…		…
1233	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";	1285	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1234		1286
1235	# 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
1236		1288
1237	($fh2, $rw)	1289	($fh2, $rw)
		1290	}
		1291
		1292	#############################################################################
		1293	# "new" API, currently only emulation of it
		1294	#############################################################################
		1295
		1296	package AE;
		1297
		1298	our $VERSION = $AnyEvent::VERSION;
		1299
		1300	sub io($$$) {
		1301	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1302	}
		1303
		1304	sub timer($$$) {
		1305	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
		1306	}
		1307
		1308	sub signal($$) {
		1309	AnyEvent->signal (signal => $_[0], cb => $_[1]);
		1310	}
		1311
		1312	sub child($$) {
		1313	AnyEvent->child (pid => $_[0], cb => $_[1]);
		1314	}
		1315
		1316	sub idle($) {
		1317	AnyEvent->idle (cb => $_[0]);
		1318	}
		1319
		1320	sub cv(;&) {
		1321	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1322	}
		1323
		1324	sub now() {
		1325	AnyEvent->now
		1326	}
		1327
		1328	sub now_update() {
		1329	AnyEvent->now_update
		1330	}
		1331
		1332	sub time() {
		1333	AnyEvent->time
1238	}	1334	}
1239		1335
1240	package AnyEvent::Base;	1336	package AnyEvent::Base;
1241		1337
1242	# default implementations for many methods	1338	# default implementations for many methods
…		…
1266	}	1362	}
1267		1363
1268	# default implementation for ->signal	1364	# default implementation for ->signal
1269		1365
1270	our $HAVE_ASYNC_INTERRUPT;	1366	our $HAVE_ASYNC_INTERRUPT;
		1367
		1368	sub _have_async_interrupt() {
		1369	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1370	&& eval "use Async::Interrupt 1.0 (); 1")
		1371	unless defined $HAVE_ASYNC_INTERRUPT;
		1372
		1373	$HAVE_ASYNC_INTERRUPT
		1374	}
		1375
1271	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1376	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1272	our (%SIG_ASY, %SIG_ASY_W);	1377	our (%SIG_ASY, %SIG_ASY_W);
1273	our ($SIG_COUNT, $SIG_TW);	1378	our ($SIG_COUNT, $SIG_TW);
1274		1379
1275	sub _signal_exec {	1380	sub _signal_exec {
…		…
1283	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1388	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1284	}	1389	}
1285	}	1390	}
1286	}	1391	}
1287		1392
1288	# install a dumym wakeupw atcher to reduce signal catching latency	1393	# install a dummy wakeup watcher to reduce signal catching latency
1289	sub _sig_add() {	1394	sub _sig_add() {
1290	unless ($SIG_COUNT++) {	1395	unless ($SIG_COUNT++) {
1291	# try to align timer on a full-second boundary, if possible	1396	# try to align timer on a full-second boundary, if possible
1292	my $NOW = AnyEvent->now;	1397	my $NOW = AE::now;
1293		1398
1294	$SIG_TW = AnyEvent->timer (	1399	$SIG_TW = AE::timer
1295	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1400	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1296	interval => $MAX_SIGNAL_LATENCY,	1401	$MAX_SIGNAL_LATENCY,
1297	cb => sub { }, # just for the PERL_ASYNC_CHECK	1402	sub { } # just for the PERL_ASYNC_CHECK
1298	);	1403	;
1299	}	1404	}
1300	}	1405	}
1301		1406
1302	sub _sig_del {	1407	sub _sig_del {
1303	undef $SIG_TW	1408	undef $SIG_TW
1304	unless --$SIG_COUNT;	1409	unless --$SIG_COUNT;
1305	}	1410	}
1306		1411
		1412	our $_sig_name_init; $_sig_name_init = sub {
		1413	eval q{ # poor man's autoloading
		1414	undef $_sig_name_init;
		1415
		1416	if (_have_async_interrupt) {
		1417	*sig2num = \&Async::Interrupt::sig2num;
		1418	*sig2name = \&Async::Interrupt::sig2name;
		1419	} else {
		1420	require Config;
		1421
		1422	my %signame2num;
		1423	@signame2num{ split ' ', $Config::Config{sig_name} }
		1424	= split ' ', $Config::Config{sig_num};
		1425
		1426	my @signum2name;
		1427	@signum2name[values %signame2num] = keys %signame2num;
		1428
		1429	*sig2num = sub($) {
		1430	$_[0] > 0 ? shift : $signame2num{+shift}
		1431	};
		1432	*sig2name = sub ($) {
		1433	$_[0] > 0 ? $signum2name[+shift] : shift
		1434	};
		1435	}
		1436	};
		1437	die if $@;
		1438	};
		1439
		1440	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1441	sub sig2name($) { &$_sig_name_init; &sig2name }
		1442
1307	sub _signal {	1443	sub signal {
		1444	eval q{ # poor man's autoloading {}
		1445	# probe for availability of Async::Interrupt
		1446	if (_have_async_interrupt) {
		1447	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1448
		1449	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1450	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1451
		1452	} else {
		1453	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1454
		1455	require Fcntl;
		1456
		1457	if (AnyEvent::WIN32) {
		1458	require AnyEvent::Util;
		1459
		1460	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1461	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1462	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1463	} else {
		1464	pipe $SIGPIPE_R, $SIGPIPE_W;
		1465	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1466	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1467
		1468	# not strictly required, as $^F is normally 2, but let's make sure...
		1469	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1470	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1471	}
		1472
		1473	$SIGPIPE_R
		1474	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1475
		1476	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1477	}
		1478
		1479	*signal = sub {
1308	my (undef, %arg) = @_;	1480	my (undef, %arg) = @_;
1309		1481
1310	my $signal = uc $arg{signal}	1482	my $signal = uc $arg{signal}
1311	or Carp::croak "required option 'signal' is missing";	1483	or Carp::croak "required option 'signal' is missing";
1312		1484
1313	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1314
1315	if ($HAVE_ASYNC_INTERRUPT) {	1485	if ($HAVE_ASYNC_INTERRUPT) {
1316	# async::interrupt	1486	# async::interrupt
1317		1487
1318	$SIG_ASY{$signal} \|\|= do {	1488	$signal = sig2num $signal;
1319	my $asy = new Async::Interrupt	1489	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1490
		1491	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1320	cb => sub { undef $SIG_EV{$signal} },	1492	cb => sub { undef $SIG_EV{$signal} },
1321	signal => $signal,	1493	signal => $signal,
1322	pipe => [$SIGPIPE_R->filenos],	1494	pipe => [$SIGPIPE_R->filenos],
		1495	pipe_autodrain => 0,
		1496	;
		1497
		1498	} else {
		1499	# pure perl
		1500
		1501	# AE::Util has been loaded in signal
		1502	$signal = sig2name $signal;
		1503	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1504
		1505	$SIG{$signal} \|\|= sub {
		1506	local $!;
		1507	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1508	undef $SIG_EV{$signal};
		1509	};
		1510
		1511	# can't do signal processing without introducing races in pure perl,
		1512	# so limit the signal latency.
		1513	_sig_add;
1323	;	1514	}
1324	$asy->pipe_autodrain (0);
1325		1515
1326	$asy	1516	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1327	};	1517	};
1328		1518
1329	} else {	1519	*AnyEvent::Base::signal::DESTROY = sub {
1330	# pure perl	1520	my ($signal, $cb) = @{$_[0]};
1331		1521
1332	$SIG{$signal} \|\|= sub {	1522	_sig_del;
1333	local $!;	1523
1334	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1524	delete $SIG_CB{$signal}{$cb};
		1525
		1526	$HAVE_ASYNC_INTERRUPT
		1527	? delete $SIG_ASY{$signal}
		1528	: # delete doesn't work with older perls - they then
		1529	# print weird messages, or just unconditionally exit
		1530	# instead of getting the default action.
1335	undef $SIG_EV{$signal};	1531	undef $SIG{$signal}
		1532	unless keys %{ $SIG_CB{$signal} };
1336	};	1533	};
1337
1338	# can't do signal processing without introducing races in pure perl,
1339	# so limit the signal latency.
1340	_sig_add;
1341	}	1534	};
1342		1535	die if $@;
1343	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1344	}
1345
1346	sub signal {
1347	# probe for availability of Async::Interrupt
1348	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1349	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1350
1351	$HAVE_ASYNC_INTERRUPT = 1;
1352	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1353	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1354
1355	} else {
1356	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1357
1358	require Fcntl;
1359
1360	if (AnyEvent::WIN32) {
1361	require AnyEvent::Util;
1362
1363	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1364	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1365	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1366	} else {
1367	pipe $SIGPIPE_R, $SIGPIPE_W;
1368	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1369	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1370
1371	# not strictly required, as $^F is normally 2, but let's make sure...
1372	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1373	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374	}
1375
1376	$SIGPIPE_R
1377	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1378
1379	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1380	}
1381
1382	*signal = \&_signal;
1383	&signal	1536	&signal
1384	}
1385
1386	sub AnyEvent::Base::signal::DESTROY {
1387	my ($signal, $cb) = @{$_[0]};
1388
1389	_sig_del;
1390
1391	delete $SIG_CB{$signal}{$cb};
1392
1393	$HAVE_ASYNC_INTERRUPT
1394	? delete $SIG_ASY{$signal}
1395	: # delete doesn't work with older perls - they then
1396	# print weird messages, or just unconditionally exit
1397	# instead of getting the default action.
1398	undef $SIG{$signal}
1399	unless keys %{ $SIG_CB{$signal} };
1400	}	1537	}
1401		1538
1402	# default implementation for ->child	1539	# default implementation for ->child
1403		1540
1404	our %PID_CB;	1541	our %PID_CB;
1405	our $CHLD_W;	1542	our $CHLD_W;
1406	our $CHLD_DELAY_W;	1543	our $CHLD_DELAY_W;
1407	our $WNOHANG;	1544	our $WNOHANG;
1408		1545
		1546	sub _emit_childstatus($$) {
		1547	my (undef, $rpid, $rstatus) = @_;
		1548
		1549	$_->($rpid, $rstatus)
		1550	for values %{ $PID_CB{$rpid} \|\| {} },
		1551	values %{ $PID_CB{0} \|\| {} };
		1552	}
		1553
1409	sub _sigchld {	1554	sub _sigchld {
		1555	my $pid;
		1556
		1557	AnyEvent->_emit_childstatus ($pid, $?)
1410	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1558	while ($pid = waitpid -1, $WNOHANG) > 0;
1411	$_->($pid, $?)
1412	for values %{ $PID_CB{$pid} \|\| {} },
1413	values %{ $PID_CB{0} \|\| {} };
1414	}
1415	}	1559	}
1416		1560
1417	sub child {	1561	sub child {
1418	my (undef, %arg) = @_;	1562	my (undef, %arg) = @_;
1419		1563
…		…
1426	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1570	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1427	? 1	1571	? 1
1428	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1572	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1429		1573
1430	unless ($CHLD_W) {	1574	unless ($CHLD_W) {
1431	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1575	$CHLD_W = AE::signal CHLD => \&_sigchld;
1432	# child could be a zombie already, so make at least one round	1576	# child could be a zombie already, so make at least one round
1433	&_sigchld;	1577	&_sigchld;
1434	}	1578	}
1435		1579
1436	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1580	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1462	# never use more then 50% of the time for the idle watcher,	1606	# never use more then 50% of the time for the idle watcher,
1463	# within some limits	1607	# within some limits
1464	$w = 0.0001 if $w < 0.0001;	1608	$w = 0.0001 if $w < 0.0001;
1465	$w = 5 if $w > 5;	1609	$w = 5 if $w > 5;
1466		1610
1467	$w = AnyEvent->timer (after => $w, cb => $rcb);	1611	$w = AE::timer $w, 0, $rcb;
1468	} else {	1612	} else {
1469	# clean up...	1613	# clean up...
1470	undef $w;	1614	undef $w;
1471	undef $rcb;	1615	undef $rcb;
1472	}	1616	}
1473	};	1617	};
1474		1618
1475	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1619	$w = AE::timer 0.05, 0, $rcb;
1476		1620
1477	bless \\$cb, "AnyEvent::Base::idle"	1621	bless \\$cb, "AnyEvent::Base::idle"
1478	}	1622	}
1479		1623
1480	sub AnyEvent::Base::idle::DESTROY {	1624	sub AnyEvent::Base::idle::DESTROY {
…		…
1534	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1678	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1535	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1679	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1536	}	1680	}
1537		1681
1538	sub cb {	1682	sub cb {
1539	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1683	my $cv = shift;
		1684
		1685	@_
		1686	and $cv->{_ae_cb} = shift
		1687	and $cv->{_ae_sent}
		1688	and (delete $cv->{_ae_cb})->($cv);
		1689
1540	$_[0]{_ae_cb}	1690	$cv->{_ae_cb}
1541	}	1691	}
1542		1692
1543	sub begin {	1693	sub begin {
1544	++$_[0]{_ae_counter};	1694	++$_[0]{_ae_counter};
1545	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1695	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
2398	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2548	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2399		2549
2400	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2550	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2401	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2551	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2402	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2552	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2403	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2553	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2404		2554
2405	Non-blocking file handles, sockets, TCP clients and	2555	Non-blocking file handles, sockets, TCP clients and
2406	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2556	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2407		2557
2408	Asynchronous DNS: L<AnyEvent::DNS>.	2558	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs. Revision 1.276 by root, Sun Aug 9 10:53:33 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs.
Revision 1.276 by root, Sun Aug 9 10:53:33 2009 UTC