… | |
… | |
41 | |
41 | |
42 | our $idle; # idle handler |
42 | our $idle; # idle handler |
43 | our $main; # main coroutine |
43 | our $main; # main coroutine |
44 | our $current; # current coroutine |
44 | our $current; # current coroutine |
45 | |
45 | |
46 | our $VERSION = '2.5'; |
46 | our $VERSION = '3.0'; |
47 | |
47 | |
48 | our @EXPORT = qw(async cede schedule terminate current); |
48 | our @EXPORT = qw(async cede schedule terminate current); |
49 | our %EXPORT_TAGS = ( |
49 | our %EXPORT_TAGS = ( |
50 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
50 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
51 | ); |
51 | ); |
… | |
… | |
117 | |
117 | |
118 | =item $idle |
118 | =item $idle |
119 | |
119 | |
120 | A callback that is called whenever the scheduler finds no ready coroutines |
120 | A callback that is called whenever the scheduler finds no ready coroutines |
121 | to run. The default implementation prints "FATAL: deadlock detected" and |
121 | to run. The default implementation prints "FATAL: deadlock detected" and |
122 | exits. |
122 | exits, because the program has no other way to continue. |
123 | |
123 | |
124 | This hook is overwritten by modules such as C<Coro::Timer> and |
124 | This hook is overwritten by modules such as C<Coro::Timer> and |
125 | C<Coro::Event> to wait on an external event that hopefully wakes up some |
125 | C<Coro::Event> to wait on an external event that hopefully wake up a |
126 | coroutine. |
126 | coroutine so the scheduler can run it. |
|
|
127 | |
|
|
128 | Please note that if your callback recursively invokes perl (e.g. for event |
|
|
129 | handlers), then it must be prepared to be called recursively. |
127 | |
130 | |
128 | =cut |
131 | =cut |
129 | |
132 | |
130 | $idle = sub { |
133 | $idle = sub { |
131 | print STDERR "FATAL: deadlock detected\n"; |
134 | print STDERR "FATAL: deadlock detected\n"; |
… | |
… | |
171 | |
174 | |
172 | Create a new asynchronous process and return it's process object |
175 | Create a new asynchronous process and return it's process object |
173 | (usually unused). When the sub returns the new process is automatically |
176 | (usually unused). When the sub returns the new process is automatically |
174 | terminated. |
177 | terminated. |
175 | |
178 | |
|
|
179 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
|
|
180 | |
176 | When the coroutine dies, the program will exit, just as in the main |
181 | When the coroutine dies, the program will exit, just as in the main |
177 | program. |
182 | program. |
178 | |
183 | |
179 | # create a new coroutine that just prints its arguments |
184 | # create a new coroutine that just prints its arguments |
180 | async { |
185 | async { |
… | |
… | |
191 | |
196 | |
192 | =item schedule |
197 | =item schedule |
193 | |
198 | |
194 | Calls the scheduler. Please note that the current process will not be put |
199 | Calls the scheduler. Please note that the current process will not be put |
195 | into the ready queue, so calling this function usually means you will |
200 | into the ready queue, so calling this function usually means you will |
196 | never be called again. |
201 | never be called again unless something else (e.g. an event handler) calls |
|
|
202 | ready. |
|
|
203 | |
|
|
204 | The canonical way to wait on external events is this: |
|
|
205 | |
|
|
206 | { |
|
|
207 | # remember current process |
|
|
208 | my $current = $Coro::current; |
|
|
209 | |
|
|
210 | # register a hypothetical event handler |
|
|
211 | on_event_invoke sub { |
|
|
212 | # wake up sleeping coroutine |
|
|
213 | $current->ready; |
|
|
214 | undef $current; |
|
|
215 | }; |
|
|
216 | |
|
|
217 | # call schedule until event occured. |
|
|
218 | # in case we are woken up for other reasons |
|
|
219 | # (current still defined), loop. |
|
|
220 | Coro::schedule while $current; |
|
|
221 | } |
197 | |
222 | |
198 | =cut |
223 | =cut |
199 | |
224 | |
200 | =item cede |
225 | =item cede |
201 | |
226 | |
… | |
… | |
230 | Create a new process and return it. When the sub returns the process |
255 | Create a new process and return it. When the sub returns the process |
231 | automatically terminates as if C<terminate> with the returned values were |
256 | automatically terminates as if C<terminate> with the returned values were |
232 | called. To make the process run you must first put it into the ready queue |
257 | called. To make the process run you must first put it into the ready queue |
233 | by calling the ready method. |
258 | by calling the ready method. |
234 | |
259 | |
|
|
260 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
|
|
261 | |
235 | =cut |
262 | =cut |
236 | |
263 | |
237 | sub _new_coro { |
264 | sub _new_coro { |
238 | terminate &{+shift}; |
265 | terminate &{+shift}; |
239 | } |
266 | } |
… | |
… | |
242 | my $class = shift; |
269 | my $class = shift; |
243 | |
270 | |
244 | $class->SUPER::new (\&_new_coro, @_) |
271 | $class->SUPER::new (\&_new_coro, @_) |
245 | } |
272 | } |
246 | |
273 | |
247 | =item $process->ready |
274 | =item $success = $process->ready |
248 | |
275 | |
249 | Put the given process into the ready queue. |
276 | Put the given process into the ready queue (according to it's priority) |
|
|
277 | and return true. If the process is already in the ready queue, do nothing |
|
|
278 | and return false. |
250 | |
279 | |
251 | =cut |
280 | =item $is_ready = $process->is_ready |
|
|
281 | |
|
|
282 | Return wether the process is currently the ready queue or not, |
252 | |
283 | |
253 | =item $process->cancel (arg...) |
284 | =item $process->cancel (arg...) |
254 | |
285 | |
255 | Terminates the given process and makes it return the given arguments as |
286 | Terminates the given process and makes it return the given arguments as |
256 | status (default: the empty list). |
287 | status (default: the empty list). |