… | |
… | |
14 | |
14 | |
15 | sub some_func : Coro { |
15 | sub some_func : Coro { |
16 | # some more async code |
16 | # some more async code |
17 | } |
17 | } |
18 | |
18 | |
19 | yield; |
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. |
… | |
… | |
28 | In this module, coroutines are defined as "callchain + lexical variables |
28 | In this module, coroutines are defined as "callchain + lexical variables |
29 | + @_ + $_ + $@ + $^W), that is, a coroutine has it's own callchain, it's |
29 | + @_ + $_ + $@ + $^W), that is, a coroutine has it's own callchain, it's |
30 | own set of lexicals and it's own set of perl's most important global |
30 | own set of lexicals and it's own set of perl's most important global |
31 | variables. |
31 | variables. |
32 | |
32 | |
|
|
33 | WARNING: When using this module, make sure that, at program end, no |
|
|
34 | coroutines are still running OR just call exit before falling off the |
|
|
35 | end. The reason for this is that some coroutine of yours might have called |
|
|
36 | into a C function, and falling off the end of main:: results in returning |
|
|
37 | to that C function instead if to the main C interpreter. |
|
|
38 | |
|
|
39 | WARNING: Unless you really know what you are doing, do NOT do context |
|
|
40 | switches inside callbacks from the XS level. The reason for this is |
|
|
41 | similar to the reason above: A callback calls a perl function, this |
|
|
42 | perl function does a context switch, some other callback is called, the |
|
|
43 | original function returns from it - to what? To the wrong XS function, |
|
|
44 | with totally different return values. Unfortunately, this includes |
|
|
45 | callbacks done by perl itself (tie'd variables!). |
|
|
46 | |
|
|
47 | The only workaround for this is to do coroutines on C level. |
|
|
48 | |
33 | =cut |
49 | =cut |
34 | |
50 | |
35 | package Coro; |
51 | package Coro; |
36 | |
52 | |
37 | use Coro::State; |
53 | use Coro::State; |
38 | |
54 | |
39 | use base Exporter; |
55 | use base Exporter; |
40 | |
56 | |
41 | $VERSION = 0.10; |
57 | $VERSION = 0.10; |
42 | |
58 | |
43 | @EXPORT = qw(async yield schedule terminate current); |
59 | @EXPORT = qw(async cede schedule terminate current); |
44 | @EXPORT_OK = qw($current); |
60 | @EXPORT_OK = qw($current); |
45 | |
61 | |
46 | { |
62 | { |
47 | my @async; |
63 | my @async; |
48 | |
64 | |
… | |
… | |
152 | # should be done using priorities :( |
168 | # should be done using priorities :( |
153 | ($prev, $current) = ($current, shift @ready || $idle); |
169 | ($prev, $current) = ($current, shift @ready || $idle); |
154 | Coro::State::transfer($prev, $current); |
170 | Coro::State::transfer($prev, $current); |
155 | } |
171 | } |
156 | |
172 | |
157 | =item yield |
173 | =item cede |
158 | |
174 | |
159 | Yield to other processes. This function puts the current process into the |
175 | "Cede" to other processes. This function puts the current process into the |
160 | ready queue and calls C<schedule>. |
176 | ready queue and calls C<schedule>, which has the effect of giving up the |
|
|
177 | current "timeslice" to other coroutines of the same or higher priority. |
161 | |
178 | |
162 | =cut |
179 | =cut |
163 | |
180 | |
164 | sub yield { |
181 | sub cede { |
165 | $current->ready; |
182 | $current->ready; |
166 | &schedule; |
183 | &schedule; |
167 | } |
184 | } |
168 | |
185 | |
169 | =item terminate |
186 | =item terminate |
… | |
… | |
173 | Future versions of this function will allow result arguments. |
190 | Future versions of this function will allow result arguments. |
174 | |
191 | |
175 | =cut |
192 | =cut |
176 | |
193 | |
177 | sub terminate { |
194 | sub terminate { |
|
|
195 | my $self = $current; |
178 | $current->{_results} = [@_]; |
196 | $self->{_results} = [@_]; |
179 | &schedule; |
197 | $current = shift @ready || $idle; |
|
|
198 | Coro::State::transfer(delete $self->{_coro_state}, $current); |
|
|
199 | # cannot return |
|
|
200 | die; |
180 | } |
201 | } |
181 | |
202 | |
182 | =back |
203 | =back |
183 | |
204 | |
184 | # dynamic methods |
205 | # dynamic methods |