… | |
… | |
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.3'; |
55 | our $VERSION = '3.56'; |
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 | ); |
… | |
… | |
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 try to do the same as calling exit |
|
|
191 | outside the coroutine, but this is experimental. It is best not to rely on |
|
|
192 | exit doing any cleanups or even not crashing. |
191 | |
193 | |
192 | When the coroutine dies, the program will exit, just as in the main |
194 | When the coroutine dies, the program will exit, just as in the main |
193 | program. |
195 | program. |
194 | |
196 | |
195 | # create a new coroutine that just prints its arguments |
197 | # create a new coroutine that just prints its arguments |
… | |
… | |
210 | Similar to C<async>, but uses a coroutine pool, so you should not call |
212 | Similar to C<async>, but uses a coroutine pool, so you should not call |
211 | terminate or join (although you are allowed to), and you get a coroutine |
213 | terminate or join (although you are allowed to), and you get a coroutine |
212 | that might have executed other code already (which can be good or bad :). |
214 | that might have executed other code already (which can be good or bad :). |
213 | |
215 | |
214 | Also, the block is executed in an C<eval> context and a warning will be |
216 | Also, the block is executed in an C<eval> context and a warning will be |
215 | issued in case of an exception instead of terminating the program, as C<async> does. |
217 | issued in case of an exception instead of terminating the program, as |
|
|
218 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
|
|
219 | will not work in the expected way, unless you call terminate or cancel, |
|
|
220 | which somehow defeats the purpose of pooling. |
216 | |
221 | |
217 | The priority will be reset to C<0> after each job, otherwise the coroutine |
222 | The priority will be reset to C<0> after each job, otherwise the coroutine |
218 | will be re-used "as-is". |
223 | will be re-used "as-is". |
219 | |
224 | |
220 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
225 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
… | |
… | |
230 | our $POOL_SIZE = 8; |
235 | our $POOL_SIZE = 8; |
231 | our @pool; |
236 | our @pool; |
232 | |
237 | |
233 | sub pool_handler { |
238 | sub pool_handler { |
234 | while () { |
239 | while () { |
235 | my ($cb, @arg) = @{ delete $current->{_invoke} }; |
|
|
236 | |
|
|
237 | eval { |
240 | eval { |
|
|
241 | my ($cb, @arg) = @{ delete $current->{_invoke} or return }; |
238 | $cb->(@arg); |
242 | $cb->(@arg); |
239 | }; |
243 | }; |
240 | warn $@ if $@; |
244 | warn $@ if $@; |
241 | |
245 | |
242 | last if @pool >= $POOL_SIZE; |
246 | last if @pool >= $POOL_SIZE; |
243 | push @pool, $current; |
247 | push @pool, $current; |
244 | |
248 | |
|
|
249 | $current->save (Coro::State::SAVE_DEF); |
245 | $current->prio (0); |
250 | $current->prio (0); |
246 | schedule; |
251 | schedule; |
247 | } |
252 | } |
248 | } |
253 | } |
249 | |
254 | |
250 | sub async_pool(&@) { |
255 | sub async_pool(&@) { |
251 | # this is also inlined into the unlock_scheduler |
256 | # this is also inlined into the unlock_scheduler |
252 | my $coro = (pop @pool or new Coro \&pool_handler); |
257 | my $coro = (pop @pool or new Coro \&pool_handler); |
253 | |
258 | |
… | |
… | |
287 | |
292 | |
288 | "Cede" to other coroutines. This function puts the current coroutine into the |
293 | "Cede" to other coroutines. This function puts the current coroutine into the |
289 | ready queue and calls C<schedule>, which has the effect of giving up the |
294 | ready queue and calls C<schedule>, which has the effect of giving up the |
290 | current "timeslice" to other coroutines of the same or higher priority. |
295 | current "timeslice" to other coroutines of the same or higher priority. |
291 | |
296 | |
|
|
297 | Returns true if at least one coroutine switch has happened. |
|
|
298 | |
292 | =item Coro::cede_notself |
299 | =item Coro::cede_notself |
293 | |
300 | |
294 | Works like cede, but is not exported by default and will cede to any |
301 | Works like cede, but is not exported by default and will cede to any |
295 | coroutine, regardless of priority, once. |
302 | coroutine, regardless of priority, once. |
|
|
303 | |
|
|
304 | Returns true if at least one coroutine switch has happened. |
296 | |
305 | |
297 | =item terminate [arg...] |
306 | =item terminate [arg...] |
298 | |
307 | |
299 | Terminates the current coroutine with the given status values (see L<cancel>). |
308 | Terminates the current coroutine with the given status values (see L<cancel>). |
300 | |
309 | |
… | |
… | |
319 | Create a new coroutine and return it. When the sub returns the coroutine |
328 | Create a new coroutine and return it. When the sub returns the coroutine |
320 | automatically terminates as if C<terminate> with the returned values were |
329 | automatically terminates as if C<terminate> with the returned values were |
321 | called. To make the coroutine run you must first put it into the ready queue |
330 | called. To make the coroutine run you must first put it into the ready queue |
322 | by calling the ready method. |
331 | by calling the ready method. |
323 | |
332 | |
324 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
333 | See C<async> for additional discussion. |
325 | |
334 | |
326 | =cut |
335 | =cut |
327 | |
336 | |
328 | sub _run_coro { |
337 | sub _run_coro { |
329 | terminate &{+shift}; |
338 | terminate &{+shift}; |
… | |
… | |
459 | and C<schedule> would cause a deadlock unless there is an idle handler |
468 | and C<schedule> would cause a deadlock unless there is an idle handler |
460 | that wakes up some coroutines. |
469 | that wakes up some coroutines. |
461 | |
470 | |
462 | =item my $guard = Coro::guard { ... } |
471 | =item my $guard = Coro::guard { ... } |
463 | |
472 | |
464 | This creates and returns a guard object. Nothing happens until the objetc |
473 | This creates and returns a guard object. Nothing happens until the object |
465 | gets destroyed, in which case the codeblock given as argument will be |
474 | gets destroyed, in which case the codeblock given as argument will be |
466 | executed. This is useful to free locks or other resources in case of a |
475 | executed. This is useful to free locks or other resources in case of a |
467 | runtime error or when the coroutine gets canceled, as in both cases the |
476 | runtime error or when the coroutine gets canceled, as in both cases the |
468 | guard block will be executed. The guard object supports only one method, |
477 | guard block will be executed. The guard object supports only one method, |
469 | C<< ->cancel >>, which will keep the codeblock from being executed. |
478 | C<< ->cancel >>, which will keep the codeblock from being executed. |