… | |
… | |
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. |
25 | |
25 | |
26 | This module is still experimental, see the BUGS section below. |
26 | This module is still experimental, see the BUGS section below. |
27 | |
27 | |
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 + C stack), that is, a coroutine has it's own |
30 | own set of lexicals and it's own set of perl's most important global |
30 | callchain, it's own set of lexicals and it's own set of perl's most |
31 | variables. |
31 | important global variables. |
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 | |
32 | |
39 | =cut |
33 | =cut |
40 | |
34 | |
41 | package Coro; |
35 | package Coro; |
42 | |
36 | |
… | |
… | |
44 | |
38 | |
45 | use base Exporter; |
39 | use base Exporter; |
46 | |
40 | |
47 | $VERSION = 0.10; |
41 | $VERSION = 0.10; |
48 | |
42 | |
49 | @EXPORT = qw(async yield schedule terminate current); |
43 | @EXPORT = qw(async cede schedule terminate current); |
50 | @EXPORT_OK = qw($current); |
44 | @EXPORT_OK = qw($current); |
51 | |
45 | |
52 | { |
46 | { |
53 | my @async; |
47 | my @async; |
54 | |
48 | |
… | |
… | |
158 | # should be done using priorities :( |
152 | # should be done using priorities :( |
159 | ($prev, $current) = ($current, shift @ready || $idle); |
153 | ($prev, $current) = ($current, shift @ready || $idle); |
160 | Coro::State::transfer($prev, $current); |
154 | Coro::State::transfer($prev, $current); |
161 | } |
155 | } |
162 | |
156 | |
163 | =item yield |
157 | =item cede |
164 | |
158 | |
165 | Yield to other processes. This function puts the current process into the |
159 | "Cede" to other processes. This function puts the current process into the |
166 | ready queue and calls C<schedule>. |
160 | ready queue and calls C<schedule>, which has the effect of giving up the |
|
|
161 | current "timeslice" to other coroutines of the same or higher priority. |
167 | |
162 | |
168 | =cut |
163 | =cut |
169 | |
164 | |
170 | sub yield { |
165 | sub cede { |
171 | $current->ready; |
166 | $current->ready; |
172 | &schedule; |
167 | &schedule; |
173 | } |
168 | } |
174 | |
169 | |
175 | =item terminate |
170 | =item terminate |
… | |
… | |
178 | |
173 | |
179 | Future versions of this function will allow result arguments. |
174 | Future versions of this function will allow result arguments. |
180 | |
175 | |
181 | =cut |
176 | =cut |
182 | |
177 | |
|
|
178 | # this coroutine is necessary because a coroutine |
|
|
179 | # cannot destroy itself. |
|
|
180 | my @destroy; |
|
|
181 | my $terminate = new Coro sub { |
|
|
182 | while() { |
|
|
183 | delete ((pop @destroy)->{_coro_state}) while @destroy; |
|
|
184 | &schedule; |
|
|
185 | } |
|
|
186 | }; |
|
|
187 | |
183 | sub terminate { |
188 | sub terminate { |
184 | $current->{_results} = [@_]; |
189 | push @destroy, $current; |
185 | delete $current->{_coro_state}; |
190 | $terminate->ready; |
186 | &schedule; |
191 | &schedule; |
|
|
192 | # NORETURN |
187 | } |
193 | } |
188 | |
194 | |
189 | =back |
195 | =back |
190 | |
196 | |
191 | # dynamic methods |
197 | # dynamic methods |