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

Comparing Coro/Coro.pm (file contents):
Revision 1.78 by root, Wed Nov 1 01:21:21 2006 UTC vs.
Revision 1.83 by root, Fri Nov 24 15:34:33 2006 UTC

… …
35use strict; 35use strict;
36no warnings "uninitialized"; 36no warnings "uninitialized";
37 37
38use Coro::State; 38use Coro::State;
39 39
40use base Exporter::; 40use base qw(Coro::State Exporter);
41 41
42our $idle; # idle coroutine 42our $idle; # idle handler
43our $main; # main coroutine 43our $main; # main coroutine
44our $current; # current coroutine 44our $current; # current coroutine
45 45
46our $VERSION = '2.1'; 46our $VERSION = '2.5';
47 47
48our @EXPORT = qw(async cede schedule terminate current); 48our @EXPORT = qw(async cede schedule terminate current);
49our %EXPORT_TAGS = ( 49our %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);
… …
95 95
96$main = new Coro; 96$main = new Coro;
97 97
98=item $current (or as function: current) 98=item $current (or as function: current)
99 99
100The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). 100The current coroutine (the last coroutine switched to). The initial value
101is C<$main> (of course).
102
103This variable is B<strictly> I<read-only>. It is provided for performance
104reasons. If performance is not essentiel you are encouraged to use the
105C<Coro::current> function instead.
101 106
102=cut 107=cut
103 108
104# maybe some other module used Coro::Specific before... 109# maybe some other module used Coro::Specific before...
105if ($current) { 110if ($current) {
… …
110 115
111sub current() { $current } 116sub current() { $current }
112 117
113=item $idle 118=item $idle
114 119
115The coroutine to switch to when no other coroutine is running. The default 120A callback that is called whenever the scheduler finds no ready coroutines
116implementation prints "FATAL: deadlock detected" and exits. 121to run. The default implementation prints "FATAL: deadlock detected" and
122exits.
117 123
118=cut 124This hook is overwritten by modules such as C<Coro::Timer> and
125C<Coro::Event> to wait on an external event that hopefully wakes up some
126coroutine.
119 127
120# should be done using priorities :( 128=cut
121$idle = new Coro sub { 129
130$idle = sub {
122 print STDERR "FATAL: deadlock detected\n"; 131 print STDERR "FATAL: deadlock detected\n";
123 exit(51); 132 exit (51);
124}; 133};
125 134
126# this coroutine is necessary because a coroutine 135# this coroutine is necessary because a coroutine
127# cannot destroy itself. 136# cannot destroy itself.
128my @destroy; 137my @destroy;
… …
137 while (@destroy) { 146 while (@destroy) {
138 my $coro = pop @destroy; 147 my $coro = pop @destroy;
139 $coro->{status} ||= []; 148 $coro->{status} ||= [];
140 $_->ready for @{delete $coro->{join} || []}; 149 $_->ready for @{delete $coro->{join} || []};
141 150
142 # the next line destroys the _coro_state, but keeps the 151 # the next line destroys the coro state, but keeps the
143 # process itself intact (we basically make it a zombie 152 # process itself intact (we basically make it a zombie
144 # process that always runs the manager thread, so it's possible 153 # process that always runs the manager thread, so it's possible
145 # to transfer() to this process). 154 # to transfer() to this process).
146 $coro->{_coro_state} = $manager->{_coro_state}; 155 $coro->_clone_state_from ($manager);
147 } 156 }
148 &schedule; 157 &schedule;
149 } 158 }
150}; 159};
151 160
… …
162=item async { ... } [@args...] 171=item async { ... } [@args...]
163 172
164Create a new asynchronous process and return it's process object 173Create a new asynchronous process and return it's process object
165(usually unused). When the sub returns the new process is automatically 174(usually unused). When the sub returns the new process is automatically
166terminated. 175terminated.
176
177When the coroutine dies, the program will exit, just as in the main
178program.
167 179
168 # create a new coroutine that just prints its arguments 180 # create a new coroutine that just prints its arguments
169 async { 181 async {
170 print "@_\n"; 182 print "@_\n";
171 } 1,2,3,4; 183 } 1,2,3,4;
… …
228 terminate &{+shift}; 240 terminate &{+shift};
229} 241}
230 242
231sub new { 243sub new {
232 my $class = shift; 244 my $class = shift;
233 bless { 245
234 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 246 $class->SUPER::new (\&_newcoro, @_)
235 }, $class;
236} 247}
237 248
238=item $process->ready 249=item $process->ready
239 250
240Put the given process into the ready queue. 251Put the given process into the ready queue.
241 252
242=cut 253=cut
243 254
244=item $process->cancel (arg...) 255=item $process->cancel (arg...)
245 256
246Temrinates the given process and makes it return the given arguments as 257Terminates the given process and makes it return the given arguments as
247status (default: the empty list). 258status (default: the empty list).
248 259
249=cut 260=cut
250 261
251sub cancel { 262sub cancel {
… …
271 &schedule; 282 &schedule;
272 } 283 }
273 wantarray ? @{$self->{status}} : $self->{status}[0]; 284 wantarray ? @{$self->{status}} : $self->{status}[0];
274} 285}
275 286
276=item $oldprio = $process->prio($newprio) 287=item $oldprio = $process->prio ($newprio)
277 288
278Sets (or gets, if the argument is missing) the priority of the 289Sets (or gets, if the argument is missing) the priority of the
279process. Higher priority processes get run before lower priority 290process. Higher priority processes get run before lower priority
280processes. Priorities are small signed integers (currently -4 .. +3), 291processes. Priorities are small signed integers (currently -4 .. +3),
281that you can refer to using PRIO_xxx constants (use the import tag :prio 292that you can refer to using PRIO_xxx constants (use the import tag :prio
… …
293Changing the priority of the current process will take effect immediately, 304Changing the priority of the current process will take effect immediately,
294but changing the priority of processes in the ready queue (but not 305but changing the priority of processes in the ready queue (but not
295running) will only take effect after the next schedule (of that 306running) will only take effect after the next schedule (of that
296process). This is a bug that will be fixed in some future version. 307process). This is a bug that will be fixed in some future version.
297 308
298=cut
299
300sub prio {
301 my $old = $_[0]{prio};
302 $_[0]{prio} = $_[1] if @_ > 1;
303 $old;
304}
305
306=item $newprio = $process->nice($change) 309=item $newprio = $process->nice ($change)
307 310
308Similar to C<prio>, but subtract the given value from the priority (i.e. 311Similar to C<prio>, but subtract the given value from the priority (i.e.
309higher values mean lower priority, just as in unix). 312higher values mean lower priority, just as in unix).
310 313
311=cut
312
313sub nice {
314 $_[0]{prio} -= $_[1];
315}
316
317=item $olddesc = $process->desc($newdesc) 314=item $olddesc = $process->desc ($newdesc)
318 315
319Sets (or gets in case the argument is missing) the description for this 316Sets (or gets in case the argument is missing) the description for this
320process. This is just a free-form string you can associate with a process. 317process. This is just a free-form string you can associate with a process.
321 318
322=cut 319=cut

Diff Legend

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