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.46 by root, Sat Feb 9 18:53:02 2002 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.532;
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 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.
140
141=back
129 142
130=head2 STATIC METHODS 143=head2 STATIC METHODS
131 144
132Static methods are actually functions that operate on the current process only. 145Static methods are actually functions that operate on the current process only.
133 146
… …
170ready 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
171current "timeslice" to other coroutines of the same or higher priority. 184current "timeslice" to other coroutines of the same or higher priority.
172 185
173=cut 186=cut
174 187
175=item terminate 188=item terminate [arg...]
176 189
177Terminates the current process. 190Terminates the current process.
178 191
179Future versions of this function will allow result arguments. 192Future versions of this function will allow result arguments.
180 193
181=cut 194=cut
182 195
183sub terminate { 196sub terminate {
197 $current->{status} = [@_];
184 $current->cancel; 198 $current->cancel;
185 &schedule; 199 &schedule;
186 die; # NORETURN 200 die; # NORETURN
187} 201}
188 202
… …
197=over 4 211=over 4
198 212
199=item new Coro \&sub [, @args...] 213=item new Coro \&sub [, @args...]
200 214
201Create 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
202automatically 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
203the ready queue by calling the ready method. 218by 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 219
208=cut 220=cut
209 221
210sub _newcoro { 222sub _newcoro {
211 terminate &{+shift}; 223 terminate &{+shift};
… …
218 }, $class; 230 }, $class;
219} 231}
220 232
221=item $process->ready 233=item $process->ready
222 234
223Put the current process into the ready queue. 235Put the given process into the ready queue.
224 236
225=cut 237=cut
226 238
227=item $process->cancel 239=item $process->cancel
228 240
… …
234 push @destroy, $_[0]; 246 push @destroy, $_[0];
235 $manager->ready; 247 $manager->ready;
236 &schedule if $current == $_[0]; 248 &schedule if $current == $_[0];
237} 249}
238 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
239=item $oldprio = $process->prio($newprio) 268=item $oldprio = $process->prio($newprio)
240 269
241Sets 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
242lower priority processes. Priorities are smalled signed integer (currently 272processes. Priorities are smalled signed integer (currently -4 .. +3),
243-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
244tag :prio to get then): 274to get then):
245 275
246 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
247 3 > 1 > 0 > -1 > -3 > -4 277 3 > 1 > 0 > -1 > -3 > -4
248 278
249 # set priority to HIGH 279 # set priority to HIGH
… …
274 304
275sub nice { 305sub nice {
276 $_[0]{prio} -= $_[1]; 306 $_[0]{prio} -= $_[1];
277} 307}
278 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
279=back 322=back
280 323
281=cut 324=cut
282 325
2831; 3261;
284 327
285=head1 BUGS/LIMITATIONS 328=head1 BUGS/LIMITATIONS
286 329
287 - 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 destruction.
288 very bad things might happen otherwise (usually segfaults). 331 very bad things might happen otherwise (usually segfaults).
289 - this module is not thread-safe. You must only ever use this module from 332 - this module is not thread-safe. You should only ever use this module from
290 the same thread (this requirement might be loosened in the future to 333 the same thread (this requirement might be loosened in the future to
291 allow per-thread schedulers, but Coro::State does not yet allow this). 334 allow per-thread schedulers, but Coro::State does not yet allow this).
292 335
293=head1 SEE ALSO 336=head1 SEE ALSO
294 337

Diff Legend

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