| … | |
… | |
| 81 | =item $Coro::main |
81 | =item $Coro::main |
| 82 | |
82 | |
| 83 | This variable stores the coroutine object that represents the main |
83 | This variable stores the coroutine object that represents the main |
| 84 | program. While you cna C<ready> it and do most other things you can do to |
84 | program. While you cna C<ready> it and do most other things you can do to |
| 85 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
85 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
| 86 | wether you are running in the main program or not. |
86 | whether you are running in the main program or not. |
| 87 | |
87 | |
| 88 | =cut |
88 | =cut |
| 89 | |
89 | |
| 90 | $main = new Coro; |
90 | $main = new Coro; |
| 91 | |
91 | |
| … | |
… | |
| 309 | This makes C<schedule> I<the> generic method to use to block the current |
309 | This makes C<schedule> I<the> generic method to use to block the current |
| 310 | coroutine and wait for events: first you remember the current coroutine in |
310 | coroutine and wait for events: first you remember the current coroutine in |
| 311 | a variable, then arrange for some callback of yours to call C<< ->ready |
311 | a variable, then arrange for some callback of yours to call C<< ->ready |
| 312 | >> on that once some event happens, and last you call C<schedule> to put |
312 | >> on that once some event happens, and last you call C<schedule> to put |
| 313 | yourself to sleep. Note that a lot of things can wake your coroutine up, |
313 | yourself to sleep. Note that a lot of things can wake your coroutine up, |
| 314 | so you need to check wether the event indeed happened, e.g. by storing the |
314 | so you need to check whether the event indeed happened, e.g. by storing the |
| 315 | status in a variable. |
315 | status in a variable. |
| 316 | |
316 | |
| 317 | The canonical way to wait on external events is this: |
317 | The canonical way to wait on external events is this: |
| 318 | |
318 | |
| 319 | { |
319 | { |
| … | |
… | |
| 358 | Kills/terminates/cancels all coroutines except the currently running |
358 | Kills/terminates/cancels all coroutines except the currently running |
| 359 | one. This is useful after a fork, either in the child or the parent, as |
359 | one. This is useful after a fork, either in the child or the parent, as |
| 360 | usually only one of them should inherit the running coroutines. |
360 | usually only one of them should inherit the running coroutines. |
| 361 | |
361 | |
| 362 | Note that while this will try to free some of the main programs resources, |
362 | Note that while this will try to free some of the main programs resources, |
| 363 | you cnanot free all of them, so if a coroutine that is not the main |
363 | you cannot free all of them, so if a coroutine that is not the main |
| 364 | program calls this function, there will be some one-time resource leak. |
364 | program calls this function, there will be some one-time resource leak. |
| 365 | |
365 | |
| 366 | =cut |
366 | =cut |
| 367 | |
367 | |
| 368 | sub terminate { |
368 | sub terminate { |
| … | |
… | |
| 417 | once all the coroutines of higher priority and all coroutines of the same |
417 | once all the coroutines of higher priority and all coroutines of the same |
| 418 | priority that were put into the ready queue earlier have been resumed. |
418 | priority that were put into the ready queue earlier have been resumed. |
| 419 | |
419 | |
| 420 | =item $is_ready = $coroutine->is_ready |
420 | =item $is_ready = $coroutine->is_ready |
| 421 | |
421 | |
| 422 | Return wether the coroutine is currently the ready queue or not, |
422 | Return whether the coroutine is currently the ready queue or not, |
| 423 | |
423 | |
| 424 | =item $coroutine->cancel (arg...) |
424 | =item $coroutine->cancel (arg...) |
| 425 | |
425 | |
| 426 | Terminates the given coroutine and makes it return the given arguments as |
426 | Terminates the given coroutine and makes it return the given arguments as |
| 427 | status (default: the empty list). Never returns if the coroutine is the |
427 | status (default: the empty list). Never returns if the coroutine is the |
