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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.15 by root, Mon Oct 30 20:55:05 2006 UTC vs.
Revision 1.25 by root, Wed Apr 11 00:36:59 2007 UTC

…		…
89	chomp (my $input = <STDIN>);	89	chomp (my $input = <STDIN>);
90	warn "read: $input\n";	90	warn "read: $input\n";
91	undef $w;	91	undef $w;
92	});	92	});
93		93
94	=head2 TIMER WATCHERS	94	=head2 TIME WATCHERS
95		95
96	You can create a timer watcher by calling the C<< AnyEvent->timer >>	96	You can create a time watcher by calling the C<< AnyEvent->timer >>
97	method with the following mandatory arguments:	97	method with the following mandatory arguments:
98		98
99	C<after> after how many seconds (fractions are supported) should the timer	99	C<after> after how many seconds (fractions are supported) should the timer
100	activate. C<cb> the callback to invoke.	100	activate. C<cb> the callback to invoke.
101		101
…		…
154	# do something such as adding a timer	154	# do something such as adding a timer
155	# or socket watcher the calls $result_ready->broadcast	155	# or socket watcher the calls $result_ready->broadcast
156	# when the "result" is ready.	156	# when the "result" is ready.
157		157
158	$result_ready->wait;	158	$result_ready->wait;
		159
		160	=back
		161
		162	=head2 SIGNAL WATCHERS
		163
		164	You can listen for signals using a signal watcher, C<signal> is the signal
		165	I<name> without any C<SIG> prefix. Multiple signals events can be clumped
		166	together into one callback invocation, and callback invocation might or
		167	might not be asynchronous.
		168
		169	These watchers might use C<%SIG>, so programs overwriting those signals
		170	directly will likely not work correctly.
		171
		172	Example: exit on SIGINT
		173
		174	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		175
		176	=head2 CHILD PROCESS WATCHERS
		177
		178	You can also listen for the status of a child process specified by the
		179	C<pid> argument. The watcher will only trigger once. This works by
		180	installing a signal handler for C<SIGCHLD>.
		181
		182	Example: wait for pid 1333
		183
		184	my $w = AnyEvent->child (pid => 1333, cb => sub { warn "exit status $?" });
		185
		186	=head1 GLOBALS
		187
		188	=over 4
		189
		190	=item $AnyEvent::MODEL
		191
		192	Contains C<undef> until the first watcher is being created. Then it
		193	contains the event model that is being used, which is the name of the
		194	Perl class implementing the model. This class is usually one of the
		195	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
		196	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
		197
		198	The known classes so far are:
		199
		200	AnyEvent::Impl::Coro based on Coro::Event, best choise.
		201	AnyEvent::Impl::Event based on Event, also best choice :)
		202	AnyEvent::Impl::Glib based on Glib, second-best choice.
		203	AnyEvent::Impl::Tk based on Tk, very bad choice.
		204	AnyEvent::Impl::Perl pure-perl implementation, inefficient.
		205
		206	=item AnyEvent::detect
		207
		208	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if
		209	necessary. You should only call this function right before you would have
		210	created an AnyEvent watcher anyway, that is, very late at runtime.
159		211
160	=back	212	=back
161		213
162	=head1 WHAT TO DO IN A MODULE	214	=head1 WHAT TO DO IN A MODULE
163		215
…		…
192	=cut	244	=cut
193		245
194	package AnyEvent;	246	package AnyEvent;
195		247
196	no warnings;	248	no warnings;
197	use strict 'vars';	249	use strict;
		250
198	use Carp;	251	use Carp;
199		252
200	our $VERSION = '2.0';	253	our $VERSION = '2.52';
201	our $MODEL;	254	our $MODEL;
202		255
203	our $AUTOLOAD;	256	our $AUTOLOAD;
204	our @ISA;	257	our @ISA;
205		258
206	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	259	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
207		260
208	our @REGISTRY;	261	our @REGISTRY;
209		262
210	my @models = (	263	my @models = (
211	[Coro::Event:: => AnyEvent::Impl::Coro::],	264	[Coro::Event:: => AnyEvent::Impl::Coro::],
212	[Event:: => AnyEvent::Impl::Event::],	265	[Event:: => AnyEvent::Impl::Event::],
213	[Glib:: => AnyEvent::Impl::Glib::],	266	[Glib:: => AnyEvent::Impl::Glib::],
214	[Tk:: => AnyEvent::Impl::Tk::],	267	[Tk:: => AnyEvent::Impl::Tk::],
215	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	268	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
216	);	269	);
217		270
218	our %method = map +($_ => 1), qw(io timer condvar broadcast wait DESTROY);	271	our %method = map +($_ => 1), qw(io timer condvar broadcast wait signal one_event DESTROY);
219		272
220	sub AUTOLOAD {	273	sub detect() {
221	$AUTOLOAD =~ s/.*://;
222
223	$method{$AUTOLOAD}
224	or croak "$AUTOLOAD: not a valid method for AnyEvent objects";
225
226	unless ($MODEL) {	274	unless ($MODEL) {
		275	no strict 'refs';
		276
227	# check for already loaded models	277	# check for already loaded models
228	for (@REGISTRY, @models) {	278	for (@REGISTRY, @models) {
229	my ($package, $model) = @$_;	279	my ($package, $model) = @$_;
230	if (${"$package\::VERSION"} > 0) {	280	if (${"$package\::VERSION"} > 0) {
231	if (eval "require $model") {	281	if (eval "require $model") {
…		…
239	unless ($MODEL) {	289	unless ($MODEL) {
240	# try to load a model	290	# try to load a model
241		291
242	for (@REGISTRY, @models) {	292	for (@REGISTRY, @models) {
243	my ($package, $model) = @$_;	293	my ($package, $model) = @$_;
		294	if (eval "require $package"
		295	and ${"$package\::VERSION"} > 0
244	if (eval "require $model") {	296	and eval "require $model") {
245	$MODEL = $model;	297	$MODEL = $model;
246	warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1;	298	warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1;
247	last;	299	last;
248	}	300	}
249	}	301	}
250		302
251	$MODEL	303	$MODEL
252	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: Coro, Event, Glib or Tk.";	304	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: Event (or Coro+Event), Glib or Tk.";
253	}	305	}
		306
		307	unshift @ISA, $MODEL;
		308	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
254	}	309	}
255		310
256	@ISA = $MODEL;	311	$MODEL
		312	}
		313
		314	sub AUTOLOAD {
		315	(my $func = $AUTOLOAD) =~ s/.*://;
		316
		317	$method{$func}
		318	or croak "$func: not a valid method for AnyEvent objects";
		319
		320	detect unless $MODEL;
257		321
258	my $class = shift;	322	my $class = shift;
259	$class->$AUTOLOAD (@_);	323	$class->$func (@_);
		324	}
		325
		326	package AnyEvent::Base;
		327
		328	# default implementation for ->condvar, ->wait, ->broadcast
		329
		330	sub condvar {
		331	bless \my $flag, "AnyEvent::Base::CondVar"
		332	}
		333
		334	sub AnyEvent::Base::CondVar::broadcast {
		335	${$_[0]}++;
		336	}
		337
		338	sub AnyEvent::Base::CondVar::wait {
		339	AnyEvent->one_event while !${$_[0]};
		340	}
		341
		342	# default implementation for ->signal
		343
		344	our %SIG_CB;
		345
		346	sub signal {
		347	my (undef, %arg) = @_;
		348
		349	my $signal = uc $arg{signal}
		350	or Carp::croak "required option 'signal' is missing";
		351
		352	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		353	$SIG{$signal} \|\|= sub {
		354	$_->() for values %{ $SIG_CB{$signal} \|\| {} };
		355	};
		356
		357	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
		358	}
		359
		360	sub AnyEvent::Base::Signal::DESTROY {
		361	my ($signal, $cb) = @{$_[0]};
		362
		363	delete $SIG_CB{$signal}{$cb};
		364
		365	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
		366	}
		367
		368	# default implementation for ->child
		369
		370	our %PID_CB;
		371	our $CHLD_W;
		372	our $PID_IDLE;
		373	our $WNOHANG;
		374
		375	sub _child_wait {
		376	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
		377	$_->() for values %{ (delete $PID_CB{$pid}) \|\| {} };
		378	}
		379
		380	undef $PID_IDLE;
		381	}
		382
		383	sub child {
		384	my (undef, %arg) = @_;
		385
		386	my $pid = uc $arg{pid}
		387	or Carp::croak "required option 'pid' is missing";
		388
		389	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
		390
		391	unless ($WNOHANG) {
		392	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } \|\| 1;
		393	}
		394
		395	unless ($CHLD_W) {
		396	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_child_wait);
		397	# child could be a zombie already
		398	$PID_IDLE \|\|= AnyEvent->timer (after => 0, cb => \&_child_wait);
		399	}
		400
		401	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"
		402	}
		403
		404	sub AnyEvent::Base::Child::DESTROY {
		405	my ($pid, $cb) = @{$_[0]};
		406
		407	delete $PID_CB{$pid}{$cb};
		408	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
		409
		410	undef $CHLD_W unless keys %PID_CB;
260	}	411	}
261		412
262	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	413	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
263		414
264	If you need to support another event library which isn't directly	415	If you need to support another event library which isn't directly
…		…
275	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>	426	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>
276	package/class when it finds the C<urxvt> package/module is loaded. When	427	package/class when it finds the C<urxvt> package/module is loaded. When
277	AnyEvent is loaded and asked to find a suitable event model, it will	428	AnyEvent is loaded and asked to find a suitable event model, it will
278	first check for the presence of urxvt.	429	first check for the presence of urxvt.
279		430
280	The class should prove implementations for all watcher types (see	431	The class should provide implementations for all watcher types (see
281	L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib>	432	L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib>
282	(Source code) and so on for actual examples, use C<perldoc -m	433	(Source code) and so on for actual examples, use C<perldoc -m
283	AnyEvent::Impl::Glib> to see the sources).	434	AnyEvent::Impl::Glib> to see the sources).
284		435
285	The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)	436	The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)
…		…
289	I<rxvt-unicode> distribution.	440	I<rxvt-unicode> distribution.
290		441
291	I<rxvt-unicode> also cheats a bit by not providing blocking access to	442	I<rxvt-unicode> also cheats a bit by not providing blocking access to
292	condition variables: code blocking while waiting for a condition will	443	condition variables: code blocking while waiting for a condition will
293	C<die>. This still works with most modules/usages, and blocking calls must	444	C<die>. This still works with most modules/usages, and blocking calls must
294	not be in an interactive appliation, so it makes sense.	445	not be in an interactive application, so it makes sense.
295		446
296	=head1 ENVIRONMENT VARIABLES	447	=head1 ENVIRONMENT VARIABLES
297		448
298	The following environment variables are used by this module:	449	The following environment variables are used by this module:
299		450

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.15 by root, Mon Oct 30 20:55:05 2006 UTC vs. Revision 1.25 by root, Wed Apr 11 00:36:59 2007 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.15 by root, Mon Oct 30 20:55:05 2006 UTC vs.
Revision 1.25 by root, Wed Apr 11 00:36:59 2007 UTC