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

Comparing Coro/Coro.pm (file contents):
Revision 1.37 by root, Mon Sep 24 02:25:44 2001 UTC vs.
Revision 1.53 by root, Tue May 27 01:15:26 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.5; 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
… …
116}; 116};
117 117
118# this coroutine is necessary because a coroutine 118# this coroutine is necessary because a coroutine
119# cannot destroy itself. 119# cannot destroy itself.
120my @destroy; 120my @destroy;
121my $manager;
121my $manager = new Coro sub { 122$manager = new Coro sub {
122 while() { 123 while() {
123 # by overwriting the state object with the manager we destroy it 124 # by overwriting the state object with the manager we destroy it
124 # while still being able to schedule this coroutine (in case it has 125 # while still being able to schedule this coroutine (in case it has
125 # been readied multiple times. this is harmless since the manager 126 # been readied multiple times. this is harmless since the manager
126 # can be called as many times as neccessary and will always 127 # can be called as many times as neccessary and will always
127 # remove itself from the runqueue 128 # remove itself from the runqueue
129 while (@destroy) {
130 my $coro = pop @destroy;
131 $coro->{status} ||= [];
132 $_->ready for @{delete $coro->{join} || []};
128 (pop @destroy)->{_coro_state} = $manager->{_coro_state} while @destroy; 133 $coro->{_coro_state} = $manager->{_coro_state};
134 }
129 &schedule; 135 &schedule;
130 } 136 }
131}; 137};
132 138
133# static methods. not really. 139# static methods. not really.
140
141=back
134 142
135=head2 STATIC METHODS 143=head2 STATIC METHODS
136 144
137Static methods are actually functions that operate on the current process only. 145Static methods are actually functions that operate on the current process only.
138 146
… …
175ready queue and calls C<schedule>, which has the effect of giving up the 183ready queue and calls C<schedule>, which has the effect of giving up the
176current "timeslice" to other coroutines of the same or higher priority. 184current "timeslice" to other coroutines of the same or higher priority.
177 185
178=cut 186=cut
179 187
180=item terminate 188=item terminate [arg...]
181 189
182Terminates the current process. 190Terminates the current process.
183 191
184Future versions of this function will allow result arguments. 192Future versions of this function will allow result arguments.
185 193
186=cut 194=cut
187 195
188sub terminate { 196sub terminate {
197 $current->{status} = [@_];
189 $current->cancel; 198 $current->cancel;
190 &schedule; 199 &schedule;
191 die; # NORETURN 200 die; # NORETURN
192} 201}
193 202
… …
202=over 4 211=over 4
203 212
204=item new Coro \&sub [, @args...] 213=item new Coro \&sub [, @args...]
205 214
206Create 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
207automatically terminates. To start the process you must first put it into 216automatically terminates as if C<terminate> with the returned values were
217called. To make the process run you must first put it into the ready queue
208the ready queue by calling the ready method. 218by calling the ready method.
209
210The coderef you submit MUST NOT be a closure that refers to variables
211in an outer scope. This does NOT work. Pass arguments into it instead.
212 219
213=cut 220=cut
214 221
215sub _newcoro { 222sub _newcoro {
216 terminate &{+shift}; 223 terminate &{+shift};
… …
223 }, $class; 230 }, $class;
224} 231}
225 232
226=item $process->ready 233=item $process->ready
227 234
228Put the current process into the ready queue. 235Put the given process into the ready queue.
229 236
230=cut 237=cut
231 238
232=item $process->cancel 239=item $process->cancel
233 240
… …
239 push @destroy, $_[0]; 246 push @destroy, $_[0];
240 $manager->ready; 247 $manager->ready;
241 &schedule if $current == $_[0]; 248 &schedule if $current == $_[0];
242} 249}
243 250
251=item $process->join
252
253Wait until the coroutine terminates and return any values given to the
254C<terminate> function. C<join> can be called multiple times from multiple
255processes.
256
257=cut
258
259sub join {
260 my $self = shift;
261 unless ($self->{status}) {
262 push @{$self->{join}}, $current;
263 &schedule;
264 }
265 wantarray ? @{$self->{status}} : $self->{status}[0];
266}
267
244=item $oldprio = $process->prio($newprio) 268=item $oldprio = $process->prio($newprio)
245 269
246Sets 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
247lower priority processes. Priorities are smalled signed integer (currently 272processes. Priorities are small signed integers (currently -4 .. +3),
248-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
249tag :prio to get then): 274to get then):
250 275
251 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
252 3 > 1 > 0 > -1 > -3 > -4 277 3 > 1 > 0 > -1 > -3 > -4
253 278
254 # set priority to HIGH 279 # set priority to HIGH
… …
279 304
280sub nice { 305sub nice {
281 $_[0]{prio} -= $_[1]; 306 $_[0]{prio} -= $_[1];
282} 307}
283 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
284=back 322=back
285 323
286=cut 324=cut
287 325
2881; 3261;
289 327
290=head1 BUGS/LIMITATIONS 328=head1 BUGS/LIMITATIONS
291 329
292 - 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
293 very bad things might happen otherwise (usually segfaults). 331 destruction. very bad things might happen otherwise (usually segfaults).
332
294 - 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
295 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
296 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).
297 337
298=head1 SEE ALSO 338=head1 SEE ALSO
299 339
300L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 340L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
301L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 341L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,

Diff Legend

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