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

Comparing Coro/Coro.pm (file contents):
Revision 1.36 by root, Mon Sep 24 01:36:20 2001 UTC vs.
Revision 1.41 by root, Tue Nov 6 20:34:09 2001 UTC

… …
38 38
39use Coro::State; 39use Coro::State;
40 40
41use base Exporter; 41use base Exporter;
42 42
43$VERSION = 0.5; 43$VERSION = 0.52;
44 44
45@EXPORT = qw(async cede schedule terminate current); 45@EXPORT = qw(async cede schedule terminate current);
46%EXPORT_TAGS = ( 46%EXPORT_TAGS = (
47 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 47 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
48); 48);
… …
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 delete ((pop @destroy)->{_coro_state}) while @destroy; 124 # by overwriting the state object with the manager we destroy it
125 # while still being able to schedule this coroutine (in case it has
126 # been readied multiple times. this is harmless since the manager
127 # can be called as many times as neccessary and will always
128 # remove itself from the runqueue
129 while (@destroy) {
130 my $coro = pop @destroy;
131 $coro->{status} ||= [];
132 $_->ready for @{delete $coro->{join} || []};
133 $coro->{_coro_state} = $manager->{_coro_state};
134 }
124 &schedule; 135 &schedule;
125 } 136 }
126}; 137};
127 138
128# static methods. not really. 139# static methods. not really.
… …
170ready queue and calls C<schedule>, which has the effect of giving up the 181ready queue and calls C<schedule>, which has the effect of giving up the
171current "timeslice" to other coroutines of the same or higher priority. 182current "timeslice" to other coroutines of the same or higher priority.
172 183
173=cut 184=cut
174 185
175=item terminate 186=item terminate [arg...]
176 187
177Terminates the current process. 188Terminates the current process.
178 189
179Future versions of this function will allow result arguments. 190Future versions of this function will allow result arguments.
180 191
181=cut 192=cut
182 193
183sub terminate { 194sub terminate {
195 $current->{status} = [@_];
184 $current->cancel; 196 $current->cancel;
185 &schedule; 197 &schedule;
186 die; # NORETURN 198 die; # NORETURN
187} 199}
188 200
… …
197=over 4 209=over 4
198 210
199=item new Coro \&sub [, @args...] 211=item new Coro \&sub [, @args...]
200 212
201Create a new process and return it. When the sub returns the process 213Create a new process and return it. When the sub returns the process
202automatically terminates. To start the process you must first put it into 214automatically terminates as if C<terminate> with the returned values were
215called. To make the process run you must first put it into the ready queue
203the ready queue by calling the ready method. 216by calling the ready method.
204
205The coderef you submit MUST NOT be a closure that refers to variables
206in an outer scope. This does NOT work. Pass arguments into it instead.
207 217
208=cut 218=cut
209 219
210sub _newcoro { 220sub _newcoro {
211 terminate &{+shift}; 221 terminate &{+shift};
… …
218 }, $class; 228 }, $class;
219} 229}
220 230
221=item $process->ready 231=item $process->ready
222 232
223Put the current process into the ready queue. 233Put the given process into the ready queue.
224 234
225=cut 235=cut
226 236
227=item $process->cancel 237=item $process->cancel
228 238
… …
234 push @destroy, $_[0]; 244 push @destroy, $_[0];
235 $manager->ready; 245 $manager->ready;
236 &schedule if $current == $_[0]; 246 &schedule if $current == $_[0];
237} 247}
238 248
249=item $process->join
250
251Wait until the coroutine terminates and return any values given to the
252C<terminate> function. C<join> can be called multiple times from multiple
253processes.
254
255=cut
256
257sub join {
258 my $self = shift;
259 unless ($self->{status}) {
260 push @{$self->{join}}, $current;
261 &schedule;
262 }
263 wantarray ? @{$self->{status}} : $self->{status}[0];
264}
265
239=item $oldprio = $process->prio($newprio) 266=item $oldprio = $process->prio($newprio)
240 267
241Sets the priority of the process. Higher priority processes get run before 268Sets (or gets, if the argument is missing) the priority of the
269process. Higher priority processes get run before lower priority
242lower priority processes. Priorities are smalled signed integer (currently 270processes. Priorities are smalled signed integer (currently -4 .. +3),
243-4 .. +3), that you can refer to using PRIO_xxx constants (use the import 271that you can refer to using PRIO_xxx constants (use the import tag :prio
244tag :prio to get then): 272to get then):
245 273
246 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 274 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
247 3 > 1 > 0 > -1 > -3 > -4 275 3 > 1 > 0 > -1 > -3 > -4
248 276
249 # set priority to HIGH 277 # set priority to HIGH
… …
272 300
273=cut 301=cut
274 302
275sub nice { 303sub nice {
276 $_[0]{prio} -= $_[1]; 304 $_[0]{prio} -= $_[1];
305}
306
307=item $olddesc = $process->desc($newdesc)
308
309Sets (or gets in case the argument is missing) the description for this
310process. This is just a free-form string you can associate with a process.
311
312=cut
313
314sub desc {
315 my $old = $_[0]{desc};
316 $_[0]{desc} = $_[1] if @_ > 1;
317 $old;
277} 318}
278 319
279=back 320=back
280 321
281=cut 322=cut

Diff Legend

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