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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.14 by root, Mon Oct 30 20:52:24 2006 UTC vs. Revision 1.31 by root, Fri Nov 2 19:20:36 2007 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.14 by root, Mon Oct 30 20:52:24 2006 UTC vs.
Revision 1.31 by root, Fri Nov 2 19:20:36 2007 UTC