| … | |
… | |
| 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 |
| … | |
… | |
| 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... |
| … | |
… | |
| 277 | # wake up sleeping coroutine |
277 | # wake up sleeping coroutine |
| 278 | $current->ready; |
278 | $current->ready; |
| 279 | undef $current; |
279 | undef $current; |
| 280 | }; |
280 | }; |
| 281 | |
281 | |
| 282 | # call schedule until event occured. |
282 | # call schedule until event occurred. |
| 283 | # in case we are woken up for other reasons |
283 | # in case we are woken up for other reasons |
| 284 | # (current still defined), loop. |
284 | # (current still defined), loop. |
| 285 | Coro::schedule while $current; |
285 | Coro::schedule while $current; |
| 286 | } |
286 | } |
| 287 | |
287 | |
| … | |
… | |
| 458 | =over 4 |
458 | =over 4 |
| 459 | |
459 | |
| 460 | =item Coro::nready |
460 | =item Coro::nready |
| 461 | |
461 | |
| 462 | Returns the number of coroutines that are currently in the ready state, |
462 | Returns the number of coroutines that are currently in the ready state, |
| 463 | i.e. that can be swicthed to. The value C<0> means that the only runnable |
463 | i.e. that can be switched to. The value C<0> means that the only runnable |
| 464 | coroutine is the currently running one, so C<cede> would have no effect, |
464 | coroutine is the currently running one, so C<cede> would have no effect, |
| 465 | and C<schedule> would cause a deadlock unless there is an idle handler |
465 | and C<schedule> would cause a deadlock unless there is an idle handler |
| 466 | that wakes up some coroutines. |
466 | that wakes up some coroutines. |
| 467 | |
467 | |
| 468 | =item my $guard = Coro::guard { ... } |
468 | =item my $guard = Coro::guard { ... } |
| … | |
… | |
| 504 | This utility function takes a BLOCK or code reference and "unblocks" it, |
504 | This utility function takes a BLOCK or code reference and "unblocks" it, |
| 505 | returning the new coderef. This means that the new coderef will return |
505 | returning the new coderef. This means that the new coderef will return |
| 506 | immediately without blocking, returning nothing, while the original code |
506 | immediately without blocking, returning nothing, while the original code |
| 507 | ref will be called (with parameters) from within its own coroutine. |
507 | ref will be called (with parameters) from within its own coroutine. |
| 508 | |
508 | |
| 509 | The reason this fucntion exists is that many event libraries (such as the |
509 | The reason this function exists is that many event libraries (such as the |
| 510 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
510 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
| 511 | of thread-safety). This means you must not block within event callbacks, |
511 | of thread-safety). This means you must not block within event callbacks, |
| 512 | otherwise you might suffer from crashes or worse. |
512 | otherwise you might suffer from crashes or worse. |
| 513 | |
513 | |
| 514 | This function allows your callbacks to block by executing them in another |
514 | This function allows your callbacks to block by executing them in another |
| … | |
… | |
| 560 | |
560 | |
| 561 | - you must make very sure that no coro is still active on global |
561 | - you must make very sure that no coro is still active on global |
| 562 | destruction. very bad things might happen otherwise (usually segfaults). |
562 | destruction. very bad things might happen otherwise (usually segfaults). |
| 563 | |
563 | |
| 564 | - this module is not thread-safe. You should only ever use this module |
564 | - this module is not thread-safe. You should only ever use this module |
| 565 | from the same thread (this requirement might be losened in the future |
565 | from the same thread (this requirement might be loosened in the future |
| 566 | to allow per-thread schedulers, but Coro::State does not yet allow |
566 | to allow per-thread schedulers, but Coro::State does not yet allow |
| 567 | this). |
567 | this). |
| 568 | |
568 | |
| 569 | =head1 SEE ALSO |
569 | =head1 SEE ALSO |
| 570 | |
570 | |
