[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.22 by root, Sun Dec 31 11:54:43 2006 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. 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
162	=head1 GLOBALS	186	=head1 GLOBALS
163		187
164	=over 4	188	=over 4
165		189
166	=item $AnyEvent::MODEL	190	=item $AnyEvent::MODEL
…		…
176	AnyEvent::Impl::Coro based on Coro::Event, best choise.	200	AnyEvent::Impl::Coro based on Coro::Event, best choise.
177	AnyEvent::Impl::Event based on Event, also best choice :)	201	AnyEvent::Impl::Event based on Event, also best choice :)
178	AnyEvent::Impl::Glib based on Glib, second-best choice.	202	AnyEvent::Impl::Glib based on Glib, second-best choice.
179	AnyEvent::Impl::Tk based on Tk, very bad choice.	203	AnyEvent::Impl::Tk based on Tk, very bad choice.
180	AnyEvent::Impl::Perl pure-perl implementation, inefficient.	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.
181		211
182	=back	212	=back
183		213
184	=head1 WHAT TO DO IN A MODULE	214	=head1 WHAT TO DO IN A MODULE
185		215
…		…
214	=cut	244	=cut
215		245
216	package AnyEvent;	246	package AnyEvent;
217		247
218	no warnings;	248	no warnings;
219	use strict 'vars';	249	use strict;
220	use Carp;	250	use Carp;
221		251
222	our $VERSION = '2.0';	252	our $VERSION = '2.51';
223	our $MODEL;	253	our $MODEL;
224		254
225	our $AUTOLOAD;	255	our $AUTOLOAD;
226	our @ISA;	256	our @ISA;
227		257
228	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	258	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
229		259
230	our @REGISTRY;	260	our @REGISTRY;
231		261
232	my @models = (	262	my @models = (
233	[Coro::Event:: => AnyEvent::Impl::Coro::],	263	[Coro::Event:: => AnyEvent::Impl::Coro::],
234	[Event:: => AnyEvent::Impl::Event::],	264	[Event:: => AnyEvent::Impl::Event::],
235	[Glib:: => AnyEvent::Impl::Glib::],	265	[Glib:: => AnyEvent::Impl::Glib::],
236	[Tk:: => AnyEvent::Impl::Tk::],	266	[Tk:: => AnyEvent::Impl::Tk::],
237	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	267	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
238	);	268	);
239		269
240	our %method = map +($_ => 1), qw(io timer condvar broadcast wait DESTROY);	270	our %method = map +($_ => 1), qw(io timer condvar broadcast wait signal one_event DESTROY);
241		271
242	sub AUTOLOAD {	272	sub detect() {
243	$AUTOLOAD =~ s/.*://;
244
245	$method{$AUTOLOAD}
246	or croak "$AUTOLOAD: not a valid method for AnyEvent objects";
247
248	unless ($MODEL) {	273	unless ($MODEL) {
		274	no strict 'refs';
		275
249	# check for already loaded models	276	# check for already loaded models
250	for (@REGISTRY, @models) {	277	for (@REGISTRY, @models) {
251	my ($package, $model) = @$_;	278	my ($package, $model) = @$_;
252	if (${"$package\::VERSION"} > 0) {	279	if (${"$package\::VERSION"} > 0) {
253	if (eval "require $model") {	280	if (eval "require $model") {
…		…
261	unless ($MODEL) {	288	unless ($MODEL) {
262	# try to load a model	289	# try to load a model
263		290
264	for (@REGISTRY, @models) {	291	for (@REGISTRY, @models) {
265	my ($package, $model) = @$_;	292	my ($package, $model) = @$_;
		293	if (eval "require $package"
		294	and ${"$package\::VERSION"} > 0
266	if (eval "require $model") {	295	and eval "require $model") {
267	$MODEL = $model;	296	$MODEL = $model;
268	warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1;	297	warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1;
269	last;	298	last;
270	}	299	}
271	}	300	}
272		301
273	$MODEL	302	$MODEL
274	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: Coro, Event, Glib or Tk.";	303	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	}	304	}
		305
		306	unshift @ISA, $MODEL;
		307	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
276	}	308	}
277		309
278	@ISA = $MODEL;	310	$MODEL
		311	}
		312
		313	sub AUTOLOAD {
		314	(my $func = $AUTOLOAD) =~ s/.*://;
		315
		316	$method{$func}
		317	or croak "$func: not a valid method for AnyEvent objects";
		318
		319	detect unless $MODEL;
279		320
280	my $class = shift;	321	my $class = shift;
281	$class->$AUTOLOAD (@_);	322	$class->$func (@_);
		323	}
		324
		325	package AnyEvent::Base;
		326
		327	# default implementation for ->condvar, ->wait, ->broadcast
		328
		329	sub condvar {
		330	bless \my $flag, "AnyEvent::Base::CondVar"
		331	}
		332
		333	sub AnyEvent::Base::CondVar::broadcast {
		334	${$_[0]}++;
		335	}
		336
		337	sub AnyEvent::Base::CondVar::wait {
		338	AnyEvent->one_event while !${$_[0]};
		339	}
		340
		341	# default implementation for ->signal
		342
		343	our %SIG_CB;
		344
		345	sub signal {
		346	my (undef, %arg) = @_;
		347
		348	my $signal = uc $arg{signal}
		349	or Carp::croak "required option 'signal' is missing";
		350
		351	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		352	$SIG{$signal} \|\|= sub {
		353	$_->() for values %{ $SIG_CB{$signal} \|\| {} };
		354	};
		355
		356	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
		357	}
		358
		359	sub AnyEvent::Base::Signal::DESTROY {
		360	my ($signal, $cb) = @{$_[0]};
		361
		362	delete $SIG_CB{$signal}{$cb};
		363
		364	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
		365	}
		366
		367	# default implementation for ->child
		368
		369	our %PID_CB;
		370	our $CHLD_W;
		371	our $PID_IDLE;
		372	our $WNOHANG;
		373
		374	sub _child_wait {
		375	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
		376	$_->() for values %{ (delete $PID_CB{$pid}) \|\| {} };
		377	}
		378
		379	undef $PID_IDLE;
		380	}
		381
		382	sub child {
		383	my (undef, %arg) = @_;
		384
		385	my $pid = uc $arg{pid}
		386	or Carp::croak "required option 'pid' is missing";
		387
		388	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
		389
		390	unless ($WNOHANG) {
		391	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_child_wait);
		392	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } \|\| 1;
		393	}
		394
		395	# child could be a zombie already
		396	$PID_IDLE \|\|= AnyEvent->timer (after => 0, cb => \&_child_wait);
		397
		398	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"
		399	}
		400
		401	sub AnyEvent::Base::Child::DESTROY {
		402	my ($pid, $cb) = @{$_[0]};
		403
		404	delete $PID_CB{$pid}{$cb};
		405	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
		406
		407	undef $CHLD_W unless keys %PID_CB;
282	}	408	}
283		409
284	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	410	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
285		411
286	If you need to support another event library which isn't directly	412	If you need to support another event library which isn't directly
…		…
297	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>	423	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>
298	package/class when it finds the C<urxvt> package/module is loaded. When	424	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	425	AnyEvent is loaded and asked to find a suitable event model, it will
300	first check for the presence of urxvt.	426	first check for the presence of urxvt.
301		427
302	The class should prove implementations for all watcher types (see	428	The class should provide implementations for all watcher types (see
303	L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib>	429	L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib>
304	(Source code) and so on for actual examples, use C<perldoc -m	430	(Source code) and so on for actual examples, use C<perldoc -m
305	AnyEvent::Impl::Glib> to see the sources).	431	AnyEvent::Impl::Glib> to see the sources).
306		432
307	The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)	433	The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)

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.22 by root, Sun Dec 31 11:54:43 2006 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.22 by root, Sun Dec 31 11:54:43 2006 UTC