| … | |
… | |
| 20 | |
20 | |
| 21 | =head1 DESCRIPTION |
21 | =head1 DESCRIPTION |
| 22 | |
22 | |
| 23 | This module collection manages coroutines. Coroutines are similar |
23 | This module collection manages coroutines. Coroutines are similar |
| 24 | to threads but don't run in parallel at the same time even on SMP |
24 | to threads but don't run in parallel at the same time even on SMP |
| 25 | machines. The specific flavor of coroutine use din this module also |
25 | machines. The specific flavor of coroutine used in this module also |
| 26 | guarentees you that it will not switch between coroutines unless |
26 | guarantees you that it will not switch between coroutines unless |
| 27 | necessary, at easily-identified points in your program, so locking and |
27 | necessary, at easily-identified points in your program, so locking and |
| 28 | parallel access are rarely an issue, making coroutine programming much |
28 | parallel access are rarely an issue, making coroutine programming much |
| 29 | safer than threads programming. |
29 | safer than threads programming. |
| 30 | |
30 | |
| 31 | (Perl, however, does not natively support real threads but instead does a |
31 | (Perl, however, does not natively support real threads but instead does a |
| … | |
… | |
| 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.55'; |
55 | our $VERSION = '3.7'; |
| 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 | ); |
| … | |
… | |
| 108 | |
108 | |
| 109 | The current coroutine (the last coroutine switched to). The initial value |
109 | The current coroutine (the last coroutine switched to). The initial value |
| 110 | is C<$main> (of course). |
110 | is C<$main> (of course). |
| 111 | |
111 | |
| 112 | This variable is B<strictly> I<read-only>. It is provided for performance |
112 | This variable is B<strictly> I<read-only>. It is provided for performance |
| 113 | reasons. If performance is not essentiel you are encouraged to use the |
113 | reasons. If performance is not essential you are encouraged to use the |
| 114 | C<Coro::current> function instead. |
114 | C<Coro::current> function instead. |
| 115 | |
115 | |
| 116 | =cut |
116 | =cut |
| 117 | |
117 | |
| 118 | # maybe some other module used Coro::Specific before... |
118 | # maybe some other module used Coro::Specific before... |
| … | |
… | |
| 185 | |
185 | |
| 186 | Create a new asynchronous coroutine and return it's coroutine object |
186 | Create a new asynchronous coroutine and return it's coroutine object |
| 187 | (usually unused). When the sub returns the new coroutine is automatically |
187 | (usually unused). When the sub returns the new coroutine is automatically |
| 188 | terminated. |
188 | terminated. |
| 189 | |
189 | |
| 190 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
190 | Calling C<exit> in a coroutine will do the same as calling exit outside |
| 191 | |
191 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
| 192 | When the coroutine dies, the program will exit, just as in the main |
192 | just as it would in the main program. |
| 193 | program. |
|
|
| 194 | |
193 | |
| 195 | # create a new coroutine that just prints its arguments |
194 | # create a new coroutine that just prints its arguments |
| 196 | async { |
195 | async { |
| 197 | print "@_\n"; |
196 | print "@_\n"; |
| 198 | } 1,2,3,4; |
197 | } 1,2,3,4; |
| … | |
… | |
| 250 | } |
249 | } |
| 251 | } |
250 | } |
| 252 | |
251 | |
| 253 | sub async_pool(&@) { |
252 | sub async_pool(&@) { |
| 254 | # this is also inlined into the unlock_scheduler |
253 | # this is also inlined into the unlock_scheduler |
|
|
254 | my $coro = (pop @pool) || do { |
| 255 | my $coro = (pop @pool or new Coro \&pool_handler); |
255 | my $coro = new Coro \&pool_handler; |
|
|
256 | $coro->{desc} = "async_pool"; |
|
|
257 | $coro |
|
|
258 | }; |
| 256 | |
259 | |
| 257 | $coro->{_invoke} = [@_]; |
260 | $coro->{_invoke} = [@_]; |
| 258 | $coro->ready; |
261 | $coro->ready; |
| 259 | |
262 | |
| 260 | $coro |
263 | $coro |
| … | |
… | |
| 278 | # wake up sleeping coroutine |
281 | # wake up sleeping coroutine |
| 279 | $current->ready; |
282 | $current->ready; |
| 280 | undef $current; |
283 | undef $current; |
| 281 | }; |
284 | }; |
| 282 | |
285 | |
| 283 | # call schedule until event occured. |
286 | # call schedule until event occurred. |
| 284 | # in case we are woken up for other reasons |
287 | # in case we are woken up for other reasons |
| 285 | # (current still defined), loop. |
288 | # (current still defined), loop. |
| 286 | Coro::schedule while $current; |
289 | Coro::schedule while $current; |
| 287 | } |
290 | } |
| 288 | |
291 | |
| … | |
… | |
| 326 | Create a new coroutine and return it. When the sub returns the coroutine |
329 | Create a new coroutine and return it. When the sub returns the coroutine |
| 327 | automatically terminates as if C<terminate> with the returned values were |
330 | automatically terminates as if C<terminate> with the returned values were |
| 328 | called. To make the coroutine run you must first put it into the ready queue |
331 | called. To make the coroutine run you must first put it into the ready queue |
| 329 | by calling the ready method. |
332 | by calling the ready method. |
| 330 | |
333 | |
| 331 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
334 | See C<async> for additional discussion. |
| 332 | |
335 | |
| 333 | =cut |
336 | =cut |
| 334 | |
337 | |
| 335 | sub _run_coro { |
338 | sub _run_coro { |
| 336 | terminate &{+shift}; |
339 | terminate &{+shift}; |
| … | |
… | |
| 459 | =over 4 |
462 | =over 4 |
| 460 | |
463 | |
| 461 | =item Coro::nready |
464 | =item Coro::nready |
| 462 | |
465 | |
| 463 | Returns the number of coroutines that are currently in the ready state, |
466 | Returns the number of coroutines that are currently in the ready state, |
| 464 | i.e. that can be swicthed to. The value C<0> means that the only runnable |
467 | i.e. that can be switched to. The value C<0> means that the only runnable |
| 465 | coroutine is the currently running one, so C<cede> would have no effect, |
468 | coroutine is the currently running one, so C<cede> would have no effect, |
| 466 | and C<schedule> would cause a deadlock unless there is an idle handler |
469 | and C<schedule> would cause a deadlock unless there is an idle handler |
| 467 | that wakes up some coroutines. |
470 | that wakes up some coroutines. |
| 468 | |
471 | |
| 469 | =item my $guard = Coro::guard { ... } |
472 | =item my $guard = Coro::guard { ... } |
| … | |
… | |
| 505 | This utility function takes a BLOCK or code reference and "unblocks" it, |
508 | This utility function takes a BLOCK or code reference and "unblocks" it, |
| 506 | returning the new coderef. This means that the new coderef will return |
509 | returning the new coderef. This means that the new coderef will return |
| 507 | immediately without blocking, returning nothing, while the original code |
510 | immediately without blocking, returning nothing, while the original code |
| 508 | ref will be called (with parameters) from within its own coroutine. |
511 | ref will be called (with parameters) from within its own coroutine. |
| 509 | |
512 | |
| 510 | The reason this fucntion exists is that many event libraries (such as the |
513 | The reason this function exists is that many event libraries (such as the |
| 511 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
514 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
| 512 | of thread-safety). This means you must not block within event callbacks, |
515 | of thread-safety). This means you must not block within event callbacks, |
| 513 | otherwise you might suffer from crashes or worse. |
516 | otherwise you might suffer from crashes or worse. |
| 514 | |
517 | |
| 515 | This function allows your callbacks to block by executing them in another |
518 | This function allows your callbacks to block by executing them in another |
| … | |
… | |
| 561 | |
564 | |
| 562 | - you must make very sure that no coro is still active on global |
565 | - you must make very sure that no coro is still active on global |
| 563 | destruction. very bad things might happen otherwise (usually segfaults). |
566 | destruction. very bad things might happen otherwise (usually segfaults). |
| 564 | |
567 | |
| 565 | - this module is not thread-safe. You should only ever use this module |
568 | - this module is not thread-safe. You should only ever use this module |
| 566 | from the same thread (this requirement might be losened in the future |
569 | from the same thread (this requirement might be loosened in the future |
| 567 | to allow per-thread schedulers, but Coro::State does not yet allow |
570 | to allow per-thread schedulers, but Coro::State does not yet allow |
| 568 | this). |
571 | this). |
| 569 | |
572 | |
| 570 | =head1 SEE ALSO |
573 | =head1 SEE ALSO |
| 571 | |
574 | |
