| … | |
… | |
| 50 | |
50 | |
| 51 | our $idle; # idle handler |
51 | our $idle; # idle handler |
| 52 | our $main; # main coroutine |
52 | our $main; # main coroutine |
| 53 | our $current; # current coroutine |
53 | our $current; # current coroutine |
| 54 | |
54 | |
| 55 | our $VERSION = '3.7'; |
55 | our $VERSION = '4.01'; |
| 56 | |
56 | |
| 57 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
57 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
| 58 | our %EXPORT_TAGS = ( |
58 | our %EXPORT_TAGS = ( |
| 59 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
59 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
| 60 | ); |
60 | ); |
| … | |
… | |
| 116 | =cut |
116 | =cut |
| 117 | |
117 | |
| 118 | $main->{desc} = "[main::]"; |
118 | $main->{desc} = "[main::]"; |
| 119 | |
119 | |
| 120 | # maybe some other module used Coro::Specific before... |
120 | # maybe some other module used Coro::Specific before... |
| 121 | $main->{specific} = $current->{specific} |
121 | $main->{_specific} = $current->{_specific} |
| 122 | if $current; |
122 | if $current; |
| 123 | |
123 | |
| 124 | _set_current $main; |
124 | _set_current $main; |
| 125 | |
125 | |
| 126 | sub current() { $current } |
126 | sub current() { $current } |
| … | |
… | |
| 151 | # free coroutine data and mark as destructed |
151 | # free coroutine data and mark as destructed |
| 152 | $self->_destroy |
152 | $self->_destroy |
| 153 | or return; |
153 | or return; |
| 154 | |
154 | |
| 155 | # call all destruction callbacks |
155 | # call all destruction callbacks |
| 156 | $_->(@{$self->{status}}) |
156 | $_->(@{$self->{_status}}) |
| 157 | for @{(delete $self->{destroy_cb}) || []}; |
157 | for @{(delete $self->{_on_destroy}) || []}; |
| 158 | } |
158 | } |
| 159 | |
159 | |
| 160 | # this coroutine is necessary because a coroutine |
160 | # this coroutine is necessary because a coroutine |
| 161 | # cannot destroy itself. |
161 | # cannot destroy itself. |
| 162 | my @destroy; |
162 | my @destroy; |
| … | |
… | |
| 186 | =item async { ... } [@args...] |
186 | =item async { ... } [@args...] |
| 187 | |
187 | |
| 188 | Create a new asynchronous coroutine and return it's coroutine object |
188 | Create a new asynchronous coroutine and return it's coroutine object |
| 189 | (usually unused). When the sub returns the new coroutine is automatically |
189 | (usually unused). When the sub returns the new coroutine is automatically |
| 190 | terminated. |
190 | terminated. |
|
|
191 | |
|
|
192 | See the C<Coro::State::new> constructor for info about the coroutine |
|
|
193 | environment. |
| 191 | |
194 | |
| 192 | Calling C<exit> in a coroutine will do the same as calling exit outside |
195 | Calling C<exit> in a coroutine will do the same as calling exit outside |
| 193 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
196 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
| 194 | just as it would in the main program. |
197 | just as it would in the main program. |
| 195 | |
198 | |
| … | |
… | |
| 216 | issued in case of an exception instead of terminating the program, as |
219 | issued in case of an exception instead of terminating the program, as |
| 217 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
220 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
| 218 | will not work in the expected way, unless you call terminate or cancel, |
221 | will not work in the expected way, unless you call terminate or cancel, |
| 219 | which somehow defeats the purpose of pooling. |
222 | which somehow defeats the purpose of pooling. |
| 220 | |
223 | |
| 221 | The priority will be reset to C<0> after each job, otherwise the coroutine |
224 | The priority will be reset to C<0> after each job, tracing will be |
| 222 | will be re-used "as-is". |
225 | disabled, the description will be reset and the default output filehandle |
|
|
226 | gets restored, so you can change alkl these. Otherwise the coroutine will |
|
|
227 | be re-used "as-is": most notably if you change other per-coroutine global |
|
|
228 | stuff such as C<$/> you need to revert that change, which is most simply |
|
|
229 | done by using local as in C< local $/ >. |
| 223 | |
230 | |
| 224 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
231 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
| 225 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
232 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
| 226 | required. |
233 | required. |
| 227 | |
234 | |
| … | |
… | |
| 241 | my $cb; |
248 | my $cb; |
| 242 | |
249 | |
| 243 | while () { |
250 | while () { |
| 244 | eval { |
251 | eval { |
| 245 | while () { |
252 | while () { |
| 246 | $cb = &_pool_1 |
253 | _pool_1 $cb; |
| 247 | or return; |
|
|
| 248 | |
|
|
| 249 | &$cb; |
254 | &$cb; |
| 250 | |
255 | _pool_2 $cb; |
| 251 | return if &_pool_2; |
|
|
| 252 | |
|
|
| 253 | undef $cb; |
|
|
| 254 | schedule; |
256 | &schedule; |
| 255 | } |
257 | } |
| 256 | }; |
258 | }; |
| 257 | |
259 | |
|
|
260 | last if $@ eq "\3terminate\2\n"; |
| 258 | warn $@ if $@; |
261 | warn $@ if $@; |
| 259 | } |
262 | } |
| 260 | } |
263 | } |
| 261 | |
264 | |
| 262 | sub async_pool(&@) { |
265 | sub async_pool(&@) { |
| 263 | # this is also inlined into the unlock_scheduler |
266 | # this is also inlined into the unlock_scheduler |
| 264 | my $coro = (pop @async_pool) || new Coro \&pool_handler;; |
267 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
| 265 | |
268 | |
| 266 | $coro->{_invoke} = [@_]; |
269 | $coro->{_invoke} = [@_]; |
| 267 | $coro->ready; |
270 | $coro->ready; |
| 268 | |
271 | |
| 269 | $coro |
272 | $coro |
| … | |
… | |
| 312 | |
315 | |
| 313 | =item terminate [arg...] |
316 | =item terminate [arg...] |
| 314 | |
317 | |
| 315 | Terminates the current coroutine with the given status values (see L<cancel>). |
318 | Terminates the current coroutine with the given status values (see L<cancel>). |
| 316 | |
319 | |
|
|
320 | =item killall |
|
|
321 | |
|
|
322 | Kills/terminates/cancels all coroutines except the currently running |
|
|
323 | one. This is useful after a fork, either in the child or the parent, as |
|
|
324 | usually only one of them should inherit the running coroutines. |
|
|
325 | |
| 317 | =cut |
326 | =cut |
| 318 | |
327 | |
| 319 | sub terminate { |
328 | sub terminate { |
| 320 | $current->cancel (@_); |
329 | $current->cancel (@_); |
|
|
330 | } |
|
|
331 | |
|
|
332 | sub killall { |
|
|
333 | for (Coro::State::list) { |
|
|
334 | $_->cancel |
|
|
335 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
|
|
336 | } |
| 321 | } |
337 | } |
| 322 | |
338 | |
| 323 | =back |
339 | =back |
| 324 | |
340 | |
| 325 | # dynamic methods |
341 | # dynamic methods |
| … | |
… | |
| 335 | Create a new coroutine and return it. When the sub returns the coroutine |
351 | Create a new coroutine and return it. When the sub returns the coroutine |
| 336 | automatically terminates as if C<terminate> with the returned values were |
352 | automatically terminates as if C<terminate> with the returned values were |
| 337 | called. To make the coroutine run you must first put it into the ready queue |
353 | called. To make the coroutine run you must first put it into the ready queue |
| 338 | by calling the ready method. |
354 | by calling the ready method. |
| 339 | |
355 | |
| 340 | See C<async> for additional discussion. |
356 | See C<async> and C<Coro::State::new> for additional info about the |
|
|
357 | coroutine environment. |
| 341 | |
358 | |
| 342 | =cut |
359 | =cut |
| 343 | |
360 | |
| 344 | sub _run_coro { |
361 | sub _run_coro { |
| 345 | terminate &{+shift}; |
362 | terminate &{+shift}; |
| … | |
… | |
| 369 | |
386 | |
| 370 | =cut |
387 | =cut |
| 371 | |
388 | |
| 372 | sub cancel { |
389 | sub cancel { |
| 373 | my $self = shift; |
390 | my $self = shift; |
| 374 | $self->{status} = [@_]; |
391 | $self->{_status} = [@_]; |
| 375 | |
392 | |
| 376 | if ($current == $self) { |
393 | if ($current == $self) { |
| 377 | push @destroy, $self; |
394 | push @destroy, $self; |
| 378 | $manager->ready; |
395 | $manager->ready; |
| 379 | &schedule while 1; |
396 | &schedule while 1; |
| … | |
… | |
| 383 | } |
400 | } |
| 384 | |
401 | |
| 385 | =item $coroutine->join |
402 | =item $coroutine->join |
| 386 | |
403 | |
| 387 | Wait until the coroutine terminates and return any values given to the |
404 | Wait until the coroutine terminates and return any values given to the |
| 388 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
405 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
| 389 | from multiple coroutine. |
406 | from multiple coroutines. |
| 390 | |
407 | |
| 391 | =cut |
408 | =cut |
| 392 | |
409 | |
| 393 | sub join { |
410 | sub join { |
| 394 | my $self = shift; |
411 | my $self = shift; |
| 395 | |
412 | |
| 396 | unless ($self->{status}) { |
413 | unless ($self->{_status}) { |
| 397 | my $current = $current; |
414 | my $current = $current; |
| 398 | |
415 | |
| 399 | push @{$self->{destroy_cb}}, sub { |
416 | push @{$self->{_on_destroy}}, sub { |
| 400 | $current->ready; |
417 | $current->ready; |
| 401 | undef $current; |
418 | undef $current; |
| 402 | }; |
419 | }; |
| 403 | |
420 | |
| 404 | &schedule while $current; |
421 | &schedule while $current; |
| 405 | } |
422 | } |
| 406 | |
423 | |
| 407 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
424 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
| 408 | } |
425 | } |
| 409 | |
426 | |
| 410 | =item $coroutine->on_destroy (\&cb) |
427 | =item $coroutine->on_destroy (\&cb) |
| 411 | |
428 | |
| 412 | Registers a callback that is called when this coroutine gets destroyed, |
429 | Registers a callback that is called when this coroutine gets destroyed, |
| … | |
… | |
| 416 | =cut |
433 | =cut |
| 417 | |
434 | |
| 418 | sub on_destroy { |
435 | sub on_destroy { |
| 419 | my ($self, $cb) = @_; |
436 | my ($self, $cb) = @_; |
| 420 | |
437 | |
| 421 | push @{ $self->{destroy_cb} }, $cb; |
438 | push @{ $self->{_on_destroy} }, $cb; |
| 422 | } |
439 | } |
| 423 | |
440 | |
| 424 | =item $oldprio = $coroutine->prio ($newprio) |
441 | =item $oldprio = $coroutine->prio ($newprio) |
| 425 | |
442 | |
| 426 | Sets (or gets, if the argument is missing) the priority of the |
443 | Sets (or gets, if the argument is missing) the priority of the |
| … | |
… | |
| 450 | |
467 | |
| 451 | =item $olddesc = $coroutine->desc ($newdesc) |
468 | =item $olddesc = $coroutine->desc ($newdesc) |
| 452 | |
469 | |
| 453 | Sets (or gets in case the argument is missing) the description for this |
470 | Sets (or gets in case the argument is missing) the description for this |
| 454 | coroutine. This is just a free-form string you can associate with a coroutine. |
471 | coroutine. This is just a free-form string you can associate with a coroutine. |
|
|
472 | |
|
|
473 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
|
|
474 | can modify this member directly if you wish. |
| 455 | |
475 | |
| 456 | =cut |
476 | =cut |
| 457 | |
477 | |
| 458 | sub desc { |
478 | sub desc { |
| 459 | my $old = $_[0]{desc}; |
479 | my $old = $_[0]{desc}; |
| … | |
… | |
| 577 | to allow per-thread schedulers, but Coro::State does not yet allow |
597 | to allow per-thread schedulers, but Coro::State does not yet allow |
| 578 | this). |
598 | this). |
| 579 | |
599 | |
| 580 | =head1 SEE ALSO |
600 | =head1 SEE ALSO |
| 581 | |
601 | |
| 582 | Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. |
602 | Support/Utility: L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. |
| 583 | |
603 | |
| 584 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
604 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
| 585 | |
605 | |
| 586 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. |
606 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. |
| 587 | |
607 | |
