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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.244 by root, Fri Jul 17 23:15:57 2009 UTC vs.
Revision 1.272 by root, Thu Aug 6 13:31:01 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
…		…
368		392
369	This watcher might use C<%SIG> (depending on the event loop used),	393	This watcher might use C<%SIG> (depending on the event loop used),
370	so programs overwriting those signals directly will likely not work	394	so programs overwriting those signals directly will likely not work
371	correctly.	395	correctly.
372		396
		397	Example: exit on SIGINT
		398
		399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		400
		401	=head3 Signal Races, Delays and Workarounds
		402
373	Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not	403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
374	support attaching callbacks to signals, which is a pity, as you cannot do	404	callbacks to signals in a generic way, which is a pity, as you cannot
375	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,
376	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
377	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
378	seconds). This variable can be changed only before the first signal	409	variable can be changed only before the first signal watcher is created,
379	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
380	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
381	saving. All these problems can be avoided by installing the optional	415	All these problems can be avoided by installing the optional
382	L<Async::Interrupt> module.	416	L<Async::Interrupt> module, which works with most event loops. It will not
383		417	work with inherently broken event loops such as L<Event> or L<Event::Lib>
384	Example: exit on SIGINT	418	(and not with L<POE> currently, as POE does it's own workaround with
385		419	one-second latency). For those, you just have to suffer the delays.
386	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387		420
388	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
389		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
390	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.
391		426
392	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,
393	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
394	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
395	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
396		432
397	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
398	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
399	callback arguments.	435	callback arguments.
400		436
…		…
441	# do something else, then wait for process exit	477	# do something else, then wait for process exit
442	$done->recv;	478	$done->recv;
443		479
444	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
445		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
446	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
447	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
448	"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
449	attention by the event loop".	487	attention by the event loop".
450		488
…		…
476	});	514	});
477	});	515	});
478		516
479	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
480		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
481	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
482	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
483	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
484		527
485	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
…		…
504	Condition variables are similar to callbacks, except that you can	547	Condition variables are similar to callbacks, except that you can
505	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
506	in time where multiple outstanding events have been processed. And yet	549	in time where multiple outstanding events have been processed. And yet
507	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
508	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
509	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.
510		554
511	Condition variables are very useful to signal that something has finished,	555	Condition variables are very useful to signal that something has finished,
512	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,
513	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
514	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
…		…
746	=item $cb = $cv->cb ($cb->($cv))	790	=item $cb = $cv->cb ($cb->($cv))
747		791
748	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
749	replaces it before doing so.	793	replaces it before doing so.
750		794
751	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)
752	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
753	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>
754	is guaranteed not to block.	798	inside the callback or at any later time is guaranteed not to block.
755		799
756	=back	800	=back
757		801
758	=head1 SUPPORTED EVENT LOOPS/BACKENDS	802	=head1 SUPPORTED EVENT LOOPS/BACKENDS
759		803
…		…
782		826
783	AnyEvent::Impl::Glib based on Glib, slow but very stable.	827	AnyEvent::Impl::Glib based on Glib, slow but very stable.
784	AnyEvent::Impl::Tk based on Tk, very broken.	828	AnyEvent::Impl::Tk based on Tk, very broken.
785	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786	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.
787		832
788	=item Backends with special needs.	833	=item Backends with special needs.
789		834
790	Qt requires the Qt::Application to be instantiated first, but will	835	Qt requires the Qt::Application to be instantiated first, but will
791	otherwise be picked up automatically. As long as the main program	836	otherwise be picked up automatically. As long as the main program
…		…
865	event module detection too early, for example, L<AnyEvent::AIO> creates	910	event module detection too early, for example, L<AnyEvent::AIO> creates
866	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
867	avoid autodetecting the event module at load time.	912	avoid autodetecting the event module at load time.
868		913
869	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
870	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
871	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;
872		934
873	=item @AnyEvent::post_detect	935	=item @AnyEvent::post_detect
874		936
875	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
876	before or after loading AnyEvent), then they will called directly after	938	before or after loading AnyEvent), then they will called directly after
…		…
1053		1115
1054	BEGIN { AnyEvent::common_sense }	1116	BEGIN { AnyEvent::common_sense }
1055		1117
1056	use Carp ();	1118	use Carp ();
1057		1119
1058	our $VERSION = 4.83;	1120	our $VERSION = 4.901;
1059	our $MODEL;	1121	our $MODEL;
1060		1122
1061	our $AUTOLOAD;	1123	our $AUTOLOAD;
1062	our @ISA;	1124	our @ISA;
1063		1125
…		…
1088	for reverse split /\s,\s/,	1150	for reverse split /\s,\s/,
1089	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1090	}	1152	}
1091		1153
1092	my @models = (	1154	my @models = (
1093	[EV:: => AnyEvent::Impl::EV::],	1155	[EV:: => AnyEvent::Impl::EV:: , 1],
1094	[Event:: => AnyEvent::Impl::Event::],	1156	[Event:: => AnyEvent::Impl::Event::, 1],
1095	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1096	# everything below here will not be autoprobed	1158	# everything below here will not (normally) be autoprobed
1097	# as the pureperl backend should work everywhere	1159	# as the pureperl backend should work everywhere
1098	# and is usually faster	1160	# and is usually faster
1099	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1100	[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
1101	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1102	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1103	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1104	[Wx:: => AnyEvent::Impl::POE::],	1167	[Wx:: => AnyEvent::Impl::POE::],
1105	[Prima:: => AnyEvent::Impl::POE::],	1168	[Prima:: => AnyEvent::Impl::POE::],
1106	# 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
1107	# byzantine signal and broken child handling, among others.	1170	# byzantine signal and broken child handling, among others.
1108	# 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
1109	# obvious default class.	1172	# obvious default class.
1110	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1111	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1112	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1113	);	1176	);
1114		1177
1115	our %method = map +($_ => 1),	1178	our %method = map +($_ => 1),
1116	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);
1117		1180
…		…
1121	my ($cb) = @_;	1184	my ($cb) = @_;
1122		1185
1123	if ($MODEL) {	1186	if ($MODEL) {
1124	$cb->();	1187	$cb->();
1125		1188
1126	1	1189	undef
1127	} else {	1190	} else {
1128	push @post_detect, $cb;	1191	push @post_detect, $cb;
1129		1192
1130	defined wantarray	1193	defined wantarray
1131	? bless \$cb, "AnyEvent::Util::postdetect"	1194	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1163	}	1226	}
1164	}	1227	}
1165	}	1228	}
1166		1229
1167	unless ($MODEL) {	1230	unless ($MODEL) {
1168	# try to load a model	1231	# try to autoload a model
1169
1170	for (@REGISTRY, @models) {	1232	for (@REGISTRY, @models) {
1171	my ($package, $model) = @$_;	1233	my ($package, $model, $autoload) = @$_;
		1234	if (
		1235	$autoload
1172	if (eval "require $package"	1236	and eval "require $package"
1173	and ${"$package\::VERSION"} > 0	1237	and ${"$package\::VERSION"} > 0
1174	and eval "require $model") {	1238	and eval "require $model"
		1239	) {
1175	$MODEL = $model;	1240	$MODEL = $model;
1176	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1241	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1177	last;	1242	last;
1178	}	1243	}
1179	}	1244	}
1180		1245
1181	$MODEL	1246	$MODEL
…		…
1253	}	1318	}
1254		1319
1255	# default implementation for ->signal	1320	# default implementation for ->signal
1256		1321
1257	our $HAVE_ASYNC_INTERRUPT;	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
1258	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1332	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1259	our (%SIG_ASY, %SIG_ASY_W);	1333	our (%SIG_ASY, %SIG_ASY_W);
1260	our ($SIG_COUNT, $SIG_TW);	1334	our ($SIG_COUNT, $SIG_TW);
1261		1335
1262	sub _signal_exec {	1336	sub _signal_exec {
…		…
1270	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1344	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1271	}	1345	}
1272	}	1346	}
1273	}	1347	}
1274		1348
		1349	# install a dummy wakeup watcher to reduce signal catching latency
1275	sub _signal {	1350	sub _sig_add() {
1276	my (undef, %arg) = @_;	1351	unless ($SIG_COUNT++) {
		1352	# try to align timer on a full-second boundary, if possible
		1353	my $NOW = AnyEvent->now;
1277		1354
1278	my $signal = uc $arg{signal}
1279	or Carp::croak "required option 'signal' is missing";
1280
1281	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1282
1283	if ($HAVE_ASYNC_INTERRUPT) {
1284	# async::interrupt
1285
1286	$SIG_ASY{$signal} \|\|= do {
1287	my $asy = new Async::Interrupt
1288	cb => sub { undef $SIG_EV{$signal} },
1289	signal => $signal,
1290	pipe => [$SIGPIPE_R->filenos],
1291	;
1292	$asy->pipe_autodrain (0);
1293
1294	$asy
1295	};
1296
1297	} else {
1298	# pure perl
1299
1300	$SIG{$signal} \|\|= sub {
1301	local $!;
1302	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1303	undef $SIG_EV{$signal};
1304	};
1305
1306	# can't do signal processing without introducing races in pure perl,
1307	# so limit the signal latency.
1308	++$SIG_COUNT;
1309	$SIG_TW \|\|= AnyEvent->timer (	1355	$SIG_TW = AnyEvent->timer (
1310	after => $MAX_SIGNAL_LATENCY,	1356	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1311	interval => $MAX_SIGNAL_LATENCY,	1357	interval => $MAX_SIGNAL_LATENCY,
1312	cb => sub { }, # just for the PERL_ASYNC_CHECK	1358	cb => sub { }, # just for the PERL_ASYNC_CHECK
1313	);	1359	);
1314	}	1360	}
1315
1316	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1317	}	1361	}
1318		1362
1319	sub signal {	1363	sub _sig_del {
1320	# probe for availability of Async::Interrupt
1321	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1322	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1323
1324	$HAVE_ASYNC_INTERRUPT = 1;
1325	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1326	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1327
1328	} else {
1329	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1330
1331	require Fcntl;
1332
1333	if (AnyEvent::WIN32) {
1334	require AnyEvent::Util;
1335
1336	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1337	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1338	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1339	} else {
1340	pipe $SIGPIPE_R, $SIGPIPE_W;
1341	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1342	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1343
1344	# not strictly required, as $^F is normally 2, but let's make sure...
1345	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1346	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1347	}
1348
1349	$SIGPIPE_R
1350	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1351
1352	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1353	}
1354
1355	*signal = \&_signal;
1356	&signal
1357	}
1358
1359	sub AnyEvent::Base::signal::DESTROY {
1360	my ($signal, $cb) = @{$_[0]};
1361
1362	undef $SIG_TW	1364	undef $SIG_TW
1363	unless --$SIG_COUNT;	1365	unless --$SIG_COUNT;
		1366	}
1364		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
		1399	sub signal {
		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;
		1404
		1405	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1406	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
		1407
		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 {
		1420	pipe $SIGPIPE_R, $SIGPIPE_W;
		1421	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1422	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1423
		1424	# not strictly required, as $^F is normally 2, but let's make sure...
		1425	fcntl $SIGPIPE_R, &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);
		1433	}
		1434
		1435	*signal = sub {
		1436	my (undef, %arg) = @_;
		1437
		1438	my $signal = uc $arg{signal}
		1439	or Carp::croak "required option 'signal' is missing";
		1440
		1441	if ($HAVE_ASYNC_INTERRUPT) {
		1442	# async::interrupt
		1443
		1444	$signal = sig2num $signal;
		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
		1461	$SIG{$signal} \|\|= sub {
		1462	local $!;
		1463	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		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
1365	delete $SIG_CB{$signal}{$cb};	1480	delete $SIG_CB{$signal}{$cb};
1366		1481
		1482	$HAVE_ASYNC_INTERRUPT
		1483	? delete $SIG_ASY{$signal}
1367	# delete doesn't work with older perls - they then	1484	: # delete doesn't work with older perls - they then
1368	# print weird messages, or just unconditionally exit	1485	# print weird messages, or just unconditionally exit
1369	# instead of getting the default action.	1486	# instead of getting the default action.
1370	undef $SIG{$signal}	1487	undef $SIG{$signal}
1371	unless keys %{ $SIG_CB{$signal} };	1488	unless keys %{ $SIG_CB{$signal} };
		1489	};
		1490	};
		1491	die if $@;
		1492	&signal
1372	}	1493	}
1373		1494
1374	# default implementation for ->child	1495	# default implementation for ->child
1375		1496
1376	our %PID_CB;	1497	our %PID_CB;
1377	our $CHLD_W;	1498	our $CHLD_W;
1378	our $CHLD_DELAY_W;	1499	our $CHLD_DELAY_W;
1379	our $WNOHANG;	1500	our $WNOHANG;
1380		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
1381	sub _sigchld {	1510	sub _sigchld {
		1511	my $pid;
		1512
		1513	AnyEvent->_emit_childstatus ($pid, $?)
1382	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1514	while ($pid = waitpid -1, $WNOHANG) > 0;
1383	$_->($pid, $?)
1384	for values %{ $PID_CB{$pid} \|\| {} },
1385	values %{ $PID_CB{0} \|\| {} };
1386	}
1387	}	1515	}
1388		1516
1389	sub child {	1517	sub child {
1390	my (undef, %arg) = @_;	1518	my (undef, %arg) = @_;
1391		1519
…		…
1506	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1634	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1507	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1635	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1508	}	1636	}
1509		1637
1510	sub cb {	1638	sub cb {
1511	$_[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);
		1645
1512	$_[0]{_ae_cb}	1646	$cv->{_ae_cb}
1513	}	1647	}
1514		1648
1515	sub begin {	1649	sub begin {
1516	++$_[0]{_ae_counter};	1650	++$_[0]{_ae_counter};
1517	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1651	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1523	}	1657	}
1524		1658
1525	# undocumented/compatibility with pre-3.4	1659	# undocumented/compatibility with pre-3.4
1526	*broadcast = \&send;	1660	*broadcast = \&send;
1527	*wait = \&_wait;	1661	*wait = \&_wait;
		1662
		1663	#############################################################################
		1664	# "new" API, currently only emulation of it
		1665	#############################################################################
		1666
		1667	package AE;
		1668
		1669	sub io($$$) {
		1670	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1671	}
		1672
		1673	sub timer($$$) {
		1674	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
		1675	}
		1676
		1677	sub signal($$) {
		1678	AnyEvent->signal (signal => $_[0], cb => $_[1]);
		1679	}
		1680
		1681	sub child($$) {
		1682	AnyEvent->child (pid => $_[0], cb => $_[1]);
		1683	}
		1684
		1685	sub idle($) {
		1686	AnyEvent->idle (cb => $_[0]);
		1687	}
		1688
		1689	sub cv(;&) {
		1690	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1691	}
		1692
		1693	sub now() {
		1694	AnyEvent->now
		1695	}
		1696
		1697	sub now_update() {
		1698	AnyEvent->now_update
		1699	}
		1700
		1701	sub time() {
		1702	AnyEvent->time
		1703	}
1528		1704
1529	=head1 ERROR AND EXCEPTION HANDLING	1705	=head1 ERROR AND EXCEPTION HANDLING
1530		1706
1531	In general, AnyEvent does not do any error handling - it relies on the	1707	In general, AnyEvent does not do any error handling - it relies on the
1532	caller to do that if required. The L<AnyEvent::Strict> module (see also	1708	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
2255		2431
2256	This slightly arcane module is used to implement fast signal handling: To	2432	This slightly arcane module is used to implement fast signal handling: To
2257	my knowledge, there is no way to do completely race-free and quick	2433	my knowledge, there is no way to do completely race-free and quick
2258	signal handling in pure perl. To ensure that signals still get	2434	signal handling in pure perl. To ensure that signals still get
2259	delivered, AnyEvent will start an interval timer to wake up perl (and	2435	delivered, AnyEvent will start an interval timer to wake up perl (and
2260	catch the signals) with soemd elay (default is 10 seconds, look for	2436	catch the signals) with some delay (default is 10 seconds, look for
2261	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2437	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2262		2438
2263	If this module is available, then it will be used to implement signal	2439	If this module is available, then it will be used to implement signal
2264	catching, which means that signals will not be delayed, and the event loop	2440	catching, which means that signals will not be delayed, and the event loop
2265	will not be interrupted regularly, which is more efficient (And good for	2441	will not be interrupted regularly, which is more efficient (And good for
2266	battery life on laptops).	2442	battery life on laptops).
2267		2443
2268	This affects not just the pure-perl event loop, but also other event loops	2444	This affects not just the pure-perl event loop, but also other event loops
2269	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2445	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2446
		2447	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2448	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2449	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2450	does nothing for those backends.
2270		2451
2271	=item L<EV>	2452	=item L<EV>
2272		2453
2273	This module isn't really "optional", as it is simply one of the backend	2454	This module isn't really "optional", as it is simply one of the backend
2274	event loops that AnyEvent can use. However, it is simply the best event	2455	event loops that AnyEvent can use. However, it is simply the best event
…		…
2288		2469
2289	=item L<JSON> and L<JSON::XS>	2470	=item L<JSON> and L<JSON::XS>
2290		2471
2291	This module is required when you want to read or write JSON data via	2472	This module is required when you want to read or write JSON data via
2292	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2473	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2293	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.	2474	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2294		2475
2295	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2476	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2296	installed.	2477	installed.
2297		2478
2298	=item L<Net::SSLeay>	2479	=item L<Net::SSLeay>
…		…
2365	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2546	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2366		2547
2367	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2548	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2368	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2549	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2369	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2550	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2370	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2551	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2371		2552
2372	Non-blocking file handles, sockets, TCP clients and	2553	Non-blocking file handles, sockets, TCP clients and
2373	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2554	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2374		2555
2375	Asynchronous DNS: L<AnyEvent::DNS>.	2556	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.244 by root, Fri Jul 17 23:15:57 2009 UTC vs. Revision 1.272 by root, Thu Aug 6 13:31:01 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.244 by root, Fri Jul 17 23:15:57 2009 UTC vs.
Revision 1.272 by root, Thu Aug 6 13:31:01 2009 UTC