… | |
… | |
19 | cede; |
19 | cede; |
20 | |
20 | |
21 | =head1 DESCRIPTION |
21 | =head1 DESCRIPTION |
22 | |
22 | |
23 | This module collection manages coroutines. Coroutines are similar to |
23 | This module collection manages coroutines. Coroutines are similar to |
24 | Threads but don't run in parallel. |
24 | threads but don't run in parallel. |
25 | |
|
|
26 | This module is still experimental, see the BUGS section below. |
|
|
27 | |
25 | |
28 | In this module, coroutines are defined as "callchain + lexical variables |
26 | In 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 |
30 | callchain, it's own set of lexicals and it's own set of perl's most |
28 | callchain, it's own set of lexicals and it's own set of perl's most |
31 | important global variables. |
29 | important global variables. |
… | |
… | |
38 | |
36 | |
39 | use Coro::State; |
37 | use Coro::State; |
40 | |
38 | |
41 | use base Exporter; |
39 | use base Exporter; |
42 | |
40 | |
43 | $VERSION = 0.51; |
41 | $VERSION = 0.52; |
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 | ); |
… | |
… | |
210 | |
208 | |
211 | =item new Coro \&sub [, @args...] |
209 | =item new Coro \&sub [, @args...] |
212 | |
210 | |
213 | Create a new process and return it. When the sub returns the process |
211 | Create a new process and return it. When the sub returns the process |
214 | automatically terminates as if C<terminate> with the returned values were |
212 | automatically terminates as if C<terminate> with the returned values were |
215 | called. To start the process you must first put it into the ready queue by |
213 | called. To make the process run you must first put it into the ready queue |
216 | calling the ready method. |
214 | by calling the ready method. |
217 | |
|
|
218 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
219 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
220 | |
215 | |
221 | =cut |
216 | =cut |
222 | |
217 | |
223 | sub _newcoro { |
218 | sub _newcoro { |
224 | terminate &{+shift}; |
219 | terminate &{+shift}; |
… | |
… | |
266 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
261 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
267 | } |
262 | } |
268 | |
263 | |
269 | =item $oldprio = $process->prio($newprio) |
264 | =item $oldprio = $process->prio($newprio) |
270 | |
265 | |
271 | Sets the priority of the process. Higher priority processes get run before |
266 | Sets (or gets, if the argument is missing) the priority of the |
|
|
267 | process. Higher priority processes get run before lower priority |
272 | lower priority processes. Priorities are smalled signed integer (currently |
268 | processes. Priorities are smalled signed integer (currently -4 .. +3), |
273 | -4 .. +3), that you can refer to using PRIO_xxx constants (use the import |
269 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
274 | tag :prio to get then): |
270 | to get then): |
275 | |
271 | |
276 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
272 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
277 | 3 > 1 > 0 > -1 > -3 > -4 |
273 | 3 > 1 > 0 > -1 > -3 > -4 |
278 | |
274 | |
279 | # set priority to HIGH |
275 | # set priority to HIGH |
… | |
… | |
304 | |
300 | |
305 | sub nice { |
301 | sub nice { |
306 | $_[0]{prio} -= $_[1]; |
302 | $_[0]{prio} -= $_[1]; |
307 | } |
303 | } |
308 | |
304 | |
|
|
305 | =item $olddesc = $process->desc($newdesc) |
|
|
306 | |
|
|
307 | Sets (or gets in case the argument is missing) the description for this |
|
|
308 | process. This is just a free-form string you can associate with a process. |
|
|
309 | |
|
|
310 | =cut |
|
|
311 | |
|
|
312 | sub desc { |
|
|
313 | my $old = $_[0]{desc}; |
|
|
314 | $_[0]{desc} = $_[1] if @_ > 1; |
|
|
315 | $old; |
|
|
316 | } |
|
|
317 | |
309 | =back |
318 | =back |
310 | |
319 | |
311 | =cut |
320 | =cut |
312 | |
321 | |
313 | 1; |
322 | 1; |
314 | |
323 | |
315 | =head1 BUGS/LIMITATIONS |
324 | =head1 BUGS/LIMITATIONS |
316 | |
325 | |
317 | - you must make very sure that no coro is still active on global destruction. |
326 | - you must make very sure that no coro is still active on global destruction. |
318 | very bad things might happen otherwise (usually segfaults). |
327 | very bad things might happen otherwise (usually segfaults). |
319 | - this module is not thread-safe. You must only ever use this module from |
328 | - this module is not thread-safe. You should only ever use this module from |
320 | the same thread (this requirement might be loosened in the future to |
329 | the same thread (this requirement might be loosened in the future to |
321 | allow per-thread schedulers, but Coro::State does not yet allow this). |
330 | allow per-thread schedulers, but Coro::State does not yet allow this). |
322 | |
331 | |
323 | =head1 SEE ALSO |
332 | =head1 SEE ALSO |
324 | |
333 | |