… | |
… | |
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.56'; |
55 | our $VERSION = '3.64'; |
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 try to do the same as calling exit |
190 | Calling C<exit> in a coroutine will do the same as calling exit outside |
191 | outside the coroutine, but this is experimental. It is best not to rely on |
191 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
192 | exit doing any cleanups or even not crashing. |
192 | just as it would in the main program. |
193 | |
|
|
194 | When the coroutine dies, the program will exit, just as in the main |
|
|
195 | program. |
|
|
196 | |
193 | |
197 | # create a new coroutine that just prints its arguments |
194 | # create a new coroutine that just prints its arguments |
198 | async { |
195 | async { |
199 | print "@_\n"; |
196 | print "@_\n"; |
200 | } 1,2,3,4; |
197 | } 1,2,3,4; |
… | |
… | |
280 | # wake up sleeping coroutine |
277 | # wake up sleeping coroutine |
281 | $current->ready; |
278 | $current->ready; |
282 | undef $current; |
279 | undef $current; |
283 | }; |
280 | }; |
284 | |
281 | |
285 | # call schedule until event occured. |
282 | # call schedule until event occurred. |
286 | # in case we are woken up for other reasons |
283 | # in case we are woken up for other reasons |
287 | # (current still defined), loop. |
284 | # (current still defined), loop. |
288 | Coro::schedule while $current; |
285 | Coro::schedule while $current; |
289 | } |
286 | } |
290 | |
287 | |
… | |
… | |
461 | =over 4 |
458 | =over 4 |
462 | |
459 | |
463 | =item Coro::nready |
460 | =item Coro::nready |
464 | |
461 | |
465 | 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, |
466 | 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 |
467 | 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, |
468 | 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 |
469 | that wakes up some coroutines. |
466 | that wakes up some coroutines. |
470 | |
467 | |
471 | =item my $guard = Coro::guard { ... } |
468 | =item my $guard = Coro::guard { ... } |
… | |
… | |
507 | 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, |
508 | 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 |
509 | immediately without blocking, returning nothing, while the original code |
506 | immediately without blocking, returning nothing, while the original code |
510 | ref will be called (with parameters) from within its own coroutine. |
507 | ref will be called (with parameters) from within its own coroutine. |
511 | |
508 | |
512 | 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 |
513 | 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 |
514 | 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, |
515 | otherwise you might suffer from crashes or worse. |
512 | otherwise you might suffer from crashes or worse. |
516 | |
513 | |
517 | 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 |
… | |
… | |
563 | |
560 | |
564 | - 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 |
565 | destruction. very bad things might happen otherwise (usually segfaults). |
562 | destruction. very bad things might happen otherwise (usually segfaults). |
566 | |
563 | |
567 | - 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 |
568 | 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 |
569 | 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 |
570 | this). |
567 | this). |
571 | |
568 | |
572 | =head1 SEE ALSO |
569 | =head1 SEE ALSO |
573 | |
570 | |