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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.16 by root, Sun Nov 5 01:08:16 2006 UTC vs.
Revision 1.32 by root, Sat Nov 3 09:29:51 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
…		…
157		157
158	$result_ready->wait;	158	$result_ready->wait;
159		159
160	=back	160	=back
161		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 (or any child if the pid argument is 0). The watcher will
		180	trigger as often as status change for the child are received. This works
		181	by installing a signal handler for C<SIGCHLD>. The callback will be called with
		182	the pid and exit status (as returned by waitpid).
		183
		184	Example: wait for pid 1333
		185
		186	my $w = AnyEvent->child (pid => 1333, cb => sub { warn "exit status $?" });
		187
162	=head1 GLOBALS	188	=head1 GLOBALS
163		189
164	=over 4	190	=over 4
165		191
166	=item $AnyEvent::MODEL	192	=item $AnyEvent::MODEL
…		…
171	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	197	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
172	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	198	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
173		199
174	The known classes so far are:	200	The known classes so far are:
175		201
		202	EV::AnyEvent based on EV (an interface to libev, best choice)
176	AnyEvent::Impl::Coro based on Coro::Event, best choise.	203	AnyEvent::Impl::Coro based on Coro::Event, second best choice.
177	AnyEvent::Impl::Event based on Event, also best choice :)	204	AnyEvent::Impl::Event based on Event, also second best choice :)
178	AnyEvent::Impl::Glib based on Glib, second-best choice.	205	AnyEvent::Impl::Glib based on Glib, second-best choice.
179	AnyEvent::Impl::Tk based on Tk, very bad choice.	206	AnyEvent::Impl::Tk based on Tk, very bad choice.
180	AnyEvent::Impl::Perl pure-perl implementation, inefficient.	207	AnyEvent::Impl::Perl pure-perl implementation, inefficient.
		208
		209	=item AnyEvent::detect
		210
		211	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if
		212	necessary. You should only call this function right before you would have
		213	created an AnyEvent watcher anyway, that is, very late at runtime.
181		214
182	=back	215	=back
183		216
184	=head1 WHAT TO DO IN A MODULE	217	=head1 WHAT TO DO IN A MODULE
185		218
…		…
214	=cut	247	=cut
215		248
216	package AnyEvent;	249	package AnyEvent;
217		250
218	no warnings;	251	no warnings;
219	use strict 'vars';	252	use strict;
		253
220	use Carp;	254	use Carp;
221		255
222	our $VERSION = '2.0';	256	our $VERSION = '2.55';
223	our $MODEL;	257	our $MODEL;
224		258
225	our $AUTOLOAD;	259	our $AUTOLOAD;
226	our @ISA;	260	our @ISA;
227		261
228	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	262	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
229		263
230	our @REGISTRY;	264	our @REGISTRY;
231		265
232	my @models = (	266	my @models = (
233	[Coro::Event:: => AnyEvent::Impl::Coro::],	267	[Coro::Event:: => AnyEvent::Impl::Coro::],
		268	[EV:: => EV::AnyEvent::],
234	[Event:: => AnyEvent::Impl::Event::],	269	[Event:: => AnyEvent::Impl::Event::],
235	[Glib:: => AnyEvent::Impl::Glib::],	270	[Glib:: => AnyEvent::Impl::Glib::],
236	[Tk:: => AnyEvent::Impl::Tk::],	271	[Tk:: => AnyEvent::Impl::Tk::],
237	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	272	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
238	);	273	);
239		274
240	our %method = map +($_ => 1), qw(io timer condvar broadcast wait DESTROY);	275	our %method = map +($_ => 1), qw(io timer condvar broadcast wait signal one_event DESTROY);
241		276
242	sub AUTOLOAD {	277	sub detect() {
243	$AUTOLOAD =~ s/.*://;
244
245	$method{$AUTOLOAD}
246	or croak "$AUTOLOAD: not a valid method for AnyEvent objects";
247
248	unless ($MODEL) {	278	unless ($MODEL) {
		279	no strict 'refs';
		280
249	# check for already loaded models	281	# check for already loaded models
250	for (@REGISTRY, @models) {	282	for (@REGISTRY, @models) {
251	my ($package, $model) = @$_;	283	my ($package, $model) = @$_;
252	if (${"$package\::VERSION"} > 0) {	284	if (${"$package\::VERSION"} > 0) {
253	if (eval "require $model") {	285	if (eval "require $model") {
…		…
261	unless ($MODEL) {	293	unless ($MODEL) {
262	# try to load a model	294	# try to load a model
263		295
264	for (@REGISTRY, @models) {	296	for (@REGISTRY, @models) {
265	my ($package, $model) = @$_;	297	my ($package, $model) = @$_;
		298	if (eval "require $package"
		299	and ${"$package\::VERSION"} > 0
266	if (eval "require $model") {	300	and eval "require $model") {
267	$MODEL = $model;	301	$MODEL = $model;
268	warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1;	302	warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1;
269	last;	303	last;
270	}	304	}
271	}	305	}
272		306
273	$MODEL	307	$MODEL
274	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: Coro, Event, Glib or Tk.";	308	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: Event (or Coro+Event), Glib or Tk.";
275	}	309	}
		310
		311	unshift @ISA, $MODEL;
		312	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
276	}	313	}
277		314
278	@ISA = $MODEL;	315	$MODEL
		316	}
		317
		318	sub AUTOLOAD {
		319	(my $func = $AUTOLOAD) =~ s/.*://;
		320
		321	$method{$func}
		322	or croak "$func: not a valid method for AnyEvent objects";
		323
		324	detect unless $MODEL;
279		325
280	my $class = shift;	326	my $class = shift;
281	$class->$AUTOLOAD (@_);	327	$class->$func (@_);
		328	}
		329
		330	package AnyEvent::Base;
		331
		332	# default implementation for ->condvar, ->wait, ->broadcast
		333
		334	sub condvar {
		335	bless \my $flag, "AnyEvent::Base::CondVar"
		336	}
		337
		338	sub AnyEvent::Base::CondVar::broadcast {
		339	${$_[0]}++;
		340	}
		341
		342	sub AnyEvent::Base::CondVar::wait {
		343	AnyEvent->one_event while !${$_[0]};
		344	}
		345
		346	# default implementation for ->signal
		347
		348	our %SIG_CB;
		349
		350	sub signal {
		351	my (undef, %arg) = @_;
		352
		353	my $signal = uc $arg{signal}
		354	or Carp::croak "required option 'signal' is missing";
		355
		356	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		357	$SIG{$signal} \|\|= sub {
		358	$_->() for values %{ $SIG_CB{$signal} \|\| {} };
		359	};
		360
		361	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
		362	}
		363
		364	sub AnyEvent::Base::Signal::DESTROY {
		365	my ($signal, $cb) = @{$_[0]};
		366
		367	delete $SIG_CB{$signal}{$cb};
		368
		369	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
		370	}
		371
		372	# default implementation for ->child
		373
		374	our %PID_CB;
		375	our $CHLD_W;
		376	our $PID_IDLE;
		377	our $WNOHANG;
		378
		379	sub _child_wait {
		380	while (0 <= (my $pid = waitpid -1, $WNOHANG)) {
		381	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
		382	(values %{ $PID_CB{0} \|\| {} });
		383	}
		384
		385	undef $PID_IDLE;
		386	}
		387
		388	sub child {
		389	my (undef, %arg) = @_;
		390
		391	defined (my $pid = $arg{pid} + 0)
		392	or Carp::croak "required option 'pid' is missing";
		393
		394	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
		395
		396	unless ($WNOHANG) {
		397	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } \|\| 1;
		398	}
		399
		400	unless ($CHLD_W) {
		401	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_child_wait);
		402	# child could be a zombie already
		403	$PID_IDLE \|\|= AnyEvent->timer (after => 0, cb => \&_child_wait);
		404	}
		405
		406	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"
		407	}
		408
		409	sub AnyEvent::Base::Child::DESTROY {
		410	my ($pid, $cb) = @{$_[0]};
		411
		412	delete $PID_CB{$pid}{$cb};
		413	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
		414
		415	undef $CHLD_W unless keys %PID_CB;
282	}	416	}
283		417
284	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	418	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
285		419
286	If you need to support another event library which isn't directly	420	If you need to support another event library which isn't directly
…		…
297	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>	431	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>
298	package/class when it finds the C<urxvt> package/module is loaded. When	432	package/class when it finds the C<urxvt> package/module is loaded. When
299	AnyEvent is loaded and asked to find a suitable event model, it will	433	AnyEvent is loaded and asked to find a suitable event model, it will
300	first check for the presence of urxvt.	434	first check for the presence of urxvt.
301		435
302	The class should prove implementations for all watcher types (see	436	The class should provide implementations for all watcher types (see
303	L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib>	437	L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib>
304	(Source code) and so on for actual examples, use C<perldoc -m	438	(Source code) and so on for actual examples, use C<perldoc -m
305	AnyEvent::Impl::Glib> to see the sources).	439	AnyEvent::Impl::Glib> to see the sources).
306		440
307	The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)	441	The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)
…		…
311	I<rxvt-unicode> distribution.	445	I<rxvt-unicode> distribution.
312		446
313	I<rxvt-unicode> also cheats a bit by not providing blocking access to	447	I<rxvt-unicode> also cheats a bit by not providing blocking access to
314	condition variables: code blocking while waiting for a condition will	448	condition variables: code blocking while waiting for a condition will
315	C<die>. This still works with most modules/usages, and blocking calls must	449	C<die>. This still works with most modules/usages, and blocking calls must
316	not be in an interactive appliation, so it makes sense.	450	not be in an interactive application, so it makes sense.
317		451
318	=head1 ENVIRONMENT VARIABLES	452	=head1 ENVIRONMENT VARIABLES
319		453
320	The following environment variables are used by this module:	454	The following environment variables are used by this module:
321		455

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.16 by root, Sun Nov 5 01:08:16 2006 UTC vs. Revision 1.32 by root, Sat Nov 3 09:29:51 2007 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.16 by root, Sun Nov 5 01:08:16 2006 UTC vs.
Revision 1.32 by root, Sat Nov 3 09:29:51 2007 UTC