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.54 by pcg, Sun Sep 28 09:00:48 2003 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.7;
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);
… …
77 }; 75 };
78 } 76 }
79 77
80} 78}
81 79
80=over 4
81
82=item $main 82=item $main
83 83
84This coroutine represents the main program. 84This coroutine represents the main program.
85 85
86=cut 86=cut
… …
136 } 136 }
137}; 137};
138 138
139# static methods. not really. 139# static methods. not really.
140 140
141=back
142
141=head2 STATIC METHODS 143=head2 STATIC METHODS
142 144
143Static methods are actually functions that operate on the current process only. 145Static methods are actually functions that operate on the current process only.
144 146
145=over 4 147=over 4
… …
210 212
211=item new Coro \&sub [, @args...] 213=item new Coro \&sub [, @args...]
212 214
213Create a new process and return it. When the sub returns the process 215Create a new process and return it. When the sub returns the process
214automatically terminates as if C<terminate> with the returned values were 216automatically 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 217called. To make the process run you must first put it into the ready queue
216calling the ready method. 218by 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 219
221=cut 220=cut
222 221
223sub _newcoro { 222sub _newcoro {
224 terminate &{+shift}; 223 terminate &{+shift};
… …
266 wantarray ? @{$self->{status}} : $self->{status}[0]; 265 wantarray ? @{$self->{status}} : $self->{status}[0];
267} 266}
268 267
269=item $oldprio = $process->prio($newprio) 268=item $oldprio = $process->prio($newprio)
270 269
271Sets the priority of the process. Higher priority processes get run before 270Sets (or gets, if the argument is missing) the priority of the
271process. Higher priority processes get run before lower priority
272lower priority processes. Priorities are smalled signed integer (currently 272processes. Priorities are small signed integers (currently -4 .. +3),
273-4 .. +3), that you can refer to using PRIO_xxx constants (use the import 273that you can refer to using PRIO_xxx constants (use the import tag :prio
274tag :prio to get then): 274to get then):
275 275
276 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 276 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
277 3 > 1 > 0 > -1 > -3 > -4 277 3 > 1 > 0 > -1 > -3 > -4
278 278
279 # set priority to HIGH 279 # set priority to HIGH
… …
304 304
305sub nice { 305sub nice {
306 $_[0]{prio} -= $_[1]; 306 $_[0]{prio} -= $_[1];
307} 307}
308 308
309=item $olddesc = $process->desc($newdesc)
310
311Sets (or gets in case the argument is missing) the description for this
312process. This is just a free-form string you can associate with a process.
313
314=cut
315
316sub desc {
317 my $old = $_[0]{desc};
318 $_[0]{desc} = $_[1] if @_ > 1;
319 $old;
320}
321
309=back 322=back
310 323
311=cut 324=cut
312 325
3131; 3261;
314 327
315=head1 BUGS/LIMITATIONS 328=head1 BUGS/LIMITATIONS
316 329
317 - you must make very sure that no coro is still active on global destruction. 330 - you must make very sure that no coro is still active on global
318 very bad things might happen otherwise (usually segfaults). 331 destruction. very bad things might happen otherwise (usually segfaults).
332
319 - this module is not thread-safe. You must only ever use this module from 333 - this module is not thread-safe. You should only ever use this module
320 the same thread (this requirement might be loosened in the future to 334 from the same thread (this requirement might be losened in the future
321 allow per-thread schedulers, but Coro::State does not yet allow this). 335 to allow per-thread schedulers, but Coro::State does not yet allow
336 this).
322 337
323=head1 SEE ALSO 338=head1 SEE ALSO
324 339
325L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 340L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
326L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 341L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,
327L<Coro::Handle>, L<Coro::Socket>. 342L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.
328 343
329=head1 AUTHOR 344=head1 AUTHOR
330 345
331 Marc Lehmann <pcg@goof.com> 346 Marc Lehmann <pcg@goof.com>
332 http://www.goof.com/pcg/marc/ 347 http://www.goof.com/pcg/marc/

Diff Legend

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