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.38 by root, Wed Oct 3 01:09:56 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
… …
124 # by overwriting the state object with the manager we destroy it 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 125 # while still being able to schedule this coroutine (in case it has
126 # been readied multiple times. this is harmless since the manager 126 # been readied multiple times. this is harmless since the manager
127 # can be called as many times as neccessary and will always 127 # can be called as many times as neccessary and will always
128 # 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} || []};
129 (pop @destroy)->{_coro_state} = $manager->{_coro_state} while @destroy; 133 $coro->{_coro_state} = $manager->{_coro_state};
134 }
130 &schedule; 135 &schedule;
131 } 136 }
132}; 137};
133 138
134# static methods. not really. 139# static methods. not really.
140
141=back
135 142
136=head2 STATIC METHODS 143=head2 STATIC METHODS
137 144
138Static methods are actually functions that operate on the current process only. 145Static methods are actually functions that operate on the current process only.
139 146
… …
176ready 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
177current "timeslice" to other coroutines of the same or higher priority. 184current "timeslice" to other coroutines of the same or higher priority.
178 185
179=cut 186=cut
180 187
181=item terminate 188=item terminate [arg...]
182 189
183Terminates the current process. 190Terminates the current process.
184 191
185Future versions of this function will allow result arguments. 192Future versions of this function will allow result arguments.
186 193
187=cut 194=cut
188 195
189sub terminate { 196sub terminate {
197 $current->{status} = [@_];
190 $current->cancel; 198 $current->cancel;
191 &schedule; 199 &schedule;
192 die; # NORETURN 200 die; # NORETURN
193} 201}
194 202
… …
203=over 4 211=over 4
204 212
205=item new Coro \&sub [, @args...] 213=item new Coro \&sub [, @args...]
206 214
207Create 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
208automatically 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
209the ready queue by calling the ready method. 218by calling the ready method.
210
211The coderef you submit MUST NOT be a closure that refers to variables
212in an outer scope. This does NOT work. Pass arguments into it instead.
213 219
214=cut 220=cut
215 221
216sub _newcoro { 222sub _newcoro {
217 terminate &{+shift}; 223 terminate &{+shift};
… …
224 }, $class; 230 }, $class;
225} 231}
226 232
227=item $process->ready 233=item $process->ready
228 234
229Put the current process into the ready queue. 235Put the given process into the ready queue.
230 236
231=cut 237=cut
232 238
233=item $process->cancel 239=item $process->cancel
234 240
… …
240 push @destroy, $_[0]; 246 push @destroy, $_[0];
241 $manager->ready; 247 $manager->ready;
242 &schedule if $current == $_[0]; 248 &schedule if $current == $_[0];
243} 249}
244 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
245=item $oldprio = $process->prio($newprio) 268=item $oldprio = $process->prio($newprio)
246 269
247Sets 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
248lower priority processes. Priorities are smalled signed integer (currently 272processes. Priorities are small signed integers (currently -4 .. +3),
249-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
250tag :prio to get then): 274to get then):
251 275
252 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
253 3 > 1 > 0 > -1 > -3 > -4 277 3 > 1 > 0 > -1 > -3 > -4
254 278
255 # set priority to HIGH 279 # set priority to HIGH
… …
280 304
281sub nice { 305sub nice {
282 $_[0]{prio} -= $_[1]; 306 $_[0]{prio} -= $_[1];
283} 307}
284 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
285=back 322=back
286 323
287=cut 324=cut
288 325
2891; 3261;
290 327
291=head1 BUGS/LIMITATIONS 328=head1 BUGS/LIMITATIONS
292 329
293 - 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
294 very bad things might happen otherwise (usually segfaults). 331 destruction. very bad things might happen otherwise (usually segfaults).
332
295 - 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
296 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
297 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).
298 337
299=head1 SEE ALSO 338=head1 SEE ALSO
300 339
301L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 340L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
302L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 341L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,
303L<Coro::Handle>, L<Coro::Socket>. 342L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.
304 343
305=head1 AUTHOR 344=head1 AUTHOR
306 345
307 Marc Lehmann <pcg@goof.com> 346 Marc Lehmann <pcg@goof.com>
308 http://www.goof.com/pcg/marc/ 347 http://www.goof.com/pcg/marc/

Diff Legend

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