ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/Coro/Coro.pm
(Generate patch)

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.40 by root, Sun Oct 28 17:00:05 2001 UTC vs.
Revision 1.42 by root, Tue Nov 6 20:37:20 2001 UTC

… …
19 cede; 19 cede;
20 20
21=head1 DESCRIPTION 21=head1 DESCRIPTION
22 22
23This module collection manages coroutines. Coroutines are similar to 23This module collection manages coroutines. Coroutines are similar to
24Threads but don't run in parallel. 24threads but don't run in parallel.
25
26This module is still experimental, see the BUGS section below.
27 25
28In this module, coroutines are defined as "callchain + lexical variables 26In this module, coroutines are defined as "callchain + lexical variables
29+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own 27+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
30callchain, it's own set of lexicals and it's own set of perl's most 28callchain, it's own set of lexicals and it's own set of perl's most
31important global variables. 29important global variables.
… …
38 36
39use Coro::State; 37use Coro::State;
40 38
41use base Exporter; 39use base Exporter;
42 40
43$VERSION = 0.51; 41$VERSION = 0.52;
44 42
45@EXPORT = qw(async cede schedule terminate current); 43@EXPORT = qw(async cede schedule terminate current);
46%EXPORT_TAGS = ( 44%EXPORT_TAGS = (
47 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 45 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
48); 46);
… …
210 208
211=item new Coro \&sub [, @args...] 209=item new Coro \&sub [, @args...]
212 210
213Create a new process and return it. When the sub returns the process 211Create a new process and return it. When the sub returns the process
214automatically terminates as if C<terminate> with the returned values were 212automatically terminates as if C<terminate> with the returned values were
215called. To start the process you must first put it into the ready queue by 213called. To make the process run you must first put it into the ready queue
216calling the ready method. 214by calling the ready method.
217
218The coderef you submit MUST NOT be a closure that refers to variables
219in an outer scope. This does NOT work. Pass arguments into it instead.
220 215
221=cut 216=cut
222 217
223sub _newcoro { 218sub _newcoro {
224 terminate &{+shift}; 219 terminate &{+shift};
… …
266 wantarray ? @{$self->{status}} : $self->{status}[0]; 261 wantarray ? @{$self->{status}} : $self->{status}[0];
267} 262}
268 263
269=item $oldprio = $process->prio($newprio) 264=item $oldprio = $process->prio($newprio)
270 265
271Sets the priority of the process. Higher priority processes get run before 266Sets (or gets, if the argument is missing) the priority of the
267process. Higher priority processes get run before lower priority
272lower priority processes. Priorities are smalled signed integer (currently 268processes. Priorities are smalled signed integer (currently -4 .. +3),
273-4 .. +3), that you can refer to using PRIO_xxx constants (use the import 269that you can refer to using PRIO_xxx constants (use the import tag :prio
274tag :prio to get then): 270to get then):
275 271
276 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 272 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
277 3 > 1 > 0 > -1 > -3 > -4 273 3 > 1 > 0 > -1 > -3 > -4
278 274
279 # set priority to HIGH 275 # set priority to HIGH
… …
304 300
305sub nice { 301sub nice {
306 $_[0]{prio} -= $_[1]; 302 $_[0]{prio} -= $_[1];
307} 303}
308 304
305=item $olddesc = $process->desc($newdesc)
306
307Sets (or gets in case the argument is missing) the description for this
308process. This is just a free-form string you can associate with a process.
309
310=cut
311
312sub desc {
313 my $old = $_[0]{desc};
314 $_[0]{desc} = $_[1] if @_ > 1;
315 $old;
316}
317
309=back 318=back
310 319
311=cut 320=cut
312 321
3131; 3221;
314 323
315=head1 BUGS/LIMITATIONS 324=head1 BUGS/LIMITATIONS
316 325
317 - you must make very sure that no coro is still active on global destruction. 326 - you must make very sure that no coro is still active on global destruction.
318 very bad things might happen otherwise (usually segfaults). 327 very bad things might happen otherwise (usually segfaults).
319 - this module is not thread-safe. You must only ever use this module from 328 - this module is not thread-safe. You should only ever use this module from
320 the same thread (this requirement might be loosened in the future to 329 the same thread (this requirement might be loosened in the future to
321 allow per-thread schedulers, but Coro::State does not yet allow this). 330 allow per-thread schedulers, but Coro::State does not yet allow this).
322 331
323=head1 SEE ALSO 332=head1 SEE ALSO
324 333

Diff Legend

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