ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/Coro/Coro.pm
(Generate patch)

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.269 by root, Thu Oct 1 23:25:03 2009 UTC vs.
Revision 1.271 by root, Fri Oct 2 19:55:59 2009 UTC

… …
81 81
82our $idle; # idle handler 82our $idle; # idle handler
83our $main; # main coro 83our $main; # main coro
84our $current; # current coro 84our $current; # current coro
85 85
86our $VERSION = 5.17; 86our $VERSION = 5.2;
87 87
88our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); 88our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait);
89our %EXPORT_TAGS = ( 89our %EXPORT_TAGS = (
90 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 90 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
91); 91);
92our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); 92our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
93 93
… …
124 124
125This variable is mainly useful to integrate Coro into event loops. It is 125This variable is mainly useful to integrate Coro into event loops. It is
126usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is 126usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is
127pretty low-level functionality. 127pretty low-level functionality.
128 128
129This variable stores either a Coro object or a callback. 129This variable stores a Coro object that is put into the ready queue when
130there are no other ready threads (without invoking any ready hooks).
130 131
131If it is a callback, the it is called whenever the scheduler finds no 132The default implementation dies with "FATAL: deadlock detected.", followed
132ready coros to run. The default implementation prints "FATAL: 133by a thread listing, because the program has no other way to continue.
133deadlock detected" and exits, because the program has no other way to
134continue.
135
136If it is a coro object, then this object will be readied (without
137invoking any ready hooks, however) when the scheduler finds no other ready
138coros to run.
139 134
140This hook is overwritten by modules such as C<Coro::EV> and 135This hook is overwritten by modules such as C<Coro::EV> and
141C<Coro::AnyEvent> to wait on an external event that hopefully wake up a 136C<Coro::AnyEvent> to wait on an external event that hopefully wake up a
142coro so the scheduler can run it. 137coro so the scheduler can run it.
143 138
144Note that the callback I<must not>, under any circumstances, block
145the current coro. Normally, this is achieved by having an "idle
146coro" that calls the event loop and then blocks again, and then
147readying that coro in the idle handler, or by simply placing the idle
148coro in this variable.
149
150See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this 139See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique.
151technique.
152 140
153Please note that if your callback recursively invokes perl (e.g. for event
154handlers), then it must be prepared to be called recursively itself.
155
156=cut 141=cut
157 142
158$idle = sub { 143$idle = new Coro sub {
159 Carp::confess ("FATAL: deadlock detected"); 144 require Coro::Debug;
145 die "FATAL: deadlock detected.\n"
146 . Coro::Debug::ps_listing ();
160}; 147};
161 148
162# this coro is necessary because a coro 149# this coro is necessary because a coro
163# cannot destroy itself. 150# cannot destroy itself.
164our @destroy; 151our @destroy;
… …
272=item schedule 259=item schedule
273 260
274Calls the scheduler. The scheduler will find the next coro that is 261Calls the scheduler. The scheduler will find the next coro that is
275to be run from the ready queue and switches to it. The next coro 262to be run from the ready queue and switches to it. The next coro
276to be run is simply the one with the highest priority that is longest 263to be run is simply the one with the highest priority that is longest
277in its ready queue. If there is no coro ready, it will clal the 264in its ready queue. If there is no coro ready, it will call the
278C<$Coro::idle> hook. 265C<$Coro::idle> hook.
279 266
280Please note that the current coro will I<not> be put into the ready 267Please note that the current coro will I<not> be put into the ready
281queue, so calling this function usually means you will never be called 268queue, so calling this function usually means you will never be called
282again unless something else (e.g. an event handler) calls C<< ->ready >>, 269again unless something else (e.g. an event handler) calls C<< ->ready >>,
… …
728 unshift @unblock_queue, [$cb, @_]; 715 unshift @unblock_queue, [$cb, @_];
729 $unblock_scheduler->ready; 716 $unblock_scheduler->ready;
730 } 717 }
731} 718}
732 719
733=item $cb = Coro::rouse_cb 720=item $cb = rouse_cb
734 721
735Create and return a "rouse callback". That's a code reference that, 722Create and return a "rouse callback". That's a code reference that,
736when called, will remember a copy of its arguments and notify the owner 723when called, will remember a copy of its arguments and notify the owner
737coro of the callback. 724coro of the callback.
738 725
739See the next function. 726See the next function.
740 727
741=item @args = Coro::rouse_wait [$cb] 728=item @args = rouse_wait [$cb]
742 729
743Wait for the specified rouse callback (or the last one that was created in 730Wait for the specified rouse callback (or the last one that was created in
744this coro). 731this coro).
745 732
746As soon as the callback is invoked (or when the callback was invoked 733As soon as the callback is invoked (or when the callback was invoked

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines