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

Comparing Coro/Coro.pm (file contents):
Revision 1.186 by root, Sun May 25 01:32:36 2008 UTC vs.
Revision 1.213 by root, Tue Nov 11 03:26:58 2008 UTC

16 cede; # yield to coroutine 16 cede; # yield to coroutine
17 print "3\n"; 17 print "3\n";
18 cede; # and again 18 cede; # and again
19 19
20 # use locking 20 # use locking
21 use Coro::Semaphore;
21 my $lock = new Coro::Semaphore; 22 my $lock = new Coro::Semaphore;
22 my $locked; 23 my $locked;
23 24
24 $lock->down; 25 $lock->down;
25 $locked = 1; 26 $locked = 1;
55 56
56=cut 57=cut
57 58
58package Coro; 59package Coro;
59 60
60use strict; 61use strict qw(vars subs);
61no warnings "uninitialized"; 62no warnings "uninitialized";
62 63
63use Coro::State; 64use Coro::State;
64 65
65use base qw(Coro::State Exporter); 66use base qw(Coro::State Exporter);
66 67
67our $idle; # idle handler 68our $idle; # idle handler
68our $main; # main coroutine 69our $main; # main coroutine
69our $current; # current coroutine 70our $current; # current coroutine
70 71
71our $VERSION = '4.72'; 72our $VERSION = 4.901;
72 73
73our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); 74our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
74our %EXPORT_TAGS = ( 75our %EXPORT_TAGS = (
75 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 76 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
76); 77);
81=item $Coro::main 82=item $Coro::main
82 83
83This variable stores the coroutine object that represents the main 84This variable stores the coroutine object that represents the main
84program. While you cna C<ready> it and do most other things you can do to 85program. While you cna C<ready> it and do most other things you can do to
85coroutines, it is mainly useful to compare again C<$Coro::current>, to see 86coroutines, it is mainly useful to compare again C<$Coro::current>, to see
86wether you are running in the main program or not. 87whether you are running in the main program or not.
87 88
88=cut 89=cut
89 90
90$main = new Coro; 91$main = new Coro;
91 92
151 $self->_destroy 152 $self->_destroy
152 or return; 153 or return;
153 154
154 # call all destruction callbacks 155 # call all destruction callbacks
155 $_->(@{$self->{_status}}) 156 $_->(@{$self->{_status}})
156 for @{(delete $self->{_on_destroy}) || []}; 157 for @{ delete $self->{_on_destroy} || [] };
157} 158}
158 159
159# this coroutine is necessary because a coroutine 160# this coroutine is necessary because a coroutine
160# cannot destroy itself. 161# cannot destroy itself.
161my @destroy; 162my @destroy;
167 while @destroy; 168 while @destroy;
168 169
169 &schedule; 170 &schedule;
170 } 171 }
171}; 172};
172$manager->desc ("[coro manager]"); 173$manager->{desc} = "[coro manager]";
173$manager->prio (PRIO_MAX); 174$manager->prio (PRIO_MAX);
174 175
175=back 176=back
176 177
177=head2 SIMPLE COROUTINE CREATION 178=head2 SIMPLE COROUTINE CREATION
220terminate or join on it (although you are allowed to), and you get a 221terminate or join on it (although you are allowed to), and you get a
221coroutine that might have executed other code already (which can be good 222coroutine that might have executed other code already (which can be good
222or bad :). 223or bad :).
223 224
224On the plus side, this function is faster than creating (and destroying) 225On the plus side, this function is faster than creating (and destroying)
225a completely new coroutine, so if you need a lot of generic coroutines in 226a completly new coroutine, so if you need a lot of generic coroutines in
226quick successsion, use C<async_pool>, not C<async>. 227quick successsion, use C<async_pool>, not C<async>.
227 228
228The code block is executed in an C<eval> context and a warning will be 229The code block is executed in an C<eval> context and a warning will be
229issued in case of an exception instead of terminating the program, as 230issued in case of an exception instead of terminating the program, as
230C<async> does. As the coroutine is being reused, stuff like C<on_destroy> 231C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
234 235
235The priority will be reset to C<0> after each run, tracing will be 236The priority will be reset to C<0> after each run, tracing will be
236disabled, the description will be reset and the default output filehandle 237disabled, the description will be reset and the default output filehandle
237gets restored, so you can change all these. Otherwise the coroutine will 238gets restored, so you can change all these. Otherwise the coroutine will
238be re-used "as-is": most notably if you change other per-coroutine global 239be re-used "as-is": most notably if you change other per-coroutine global
239stuff such as C<$/> you I<must needs> to revert that change, which is most 240stuff such as C<$/> you I<must needs> revert that change, which is most
240simply done by using local as in: C< local $/ >. 241simply done by using local as in: C<< local $/ >>.
241 242
242The pool size is limited to C<8> idle coroutines (this can be adjusted by 243The idle pool size is limited to C<8> idle coroutines (this can be
243changing $Coro::POOL_SIZE), and there can be as many non-idle coros as 244adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle
244required. 245coros as required.
245 246
246If you are concerned about pooled coroutines growing a lot because a 247If you are concerned about pooled coroutines growing a lot because a
247single C<async_pool> used a lot of stackspace you can e.g. C<async_pool 248single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
248{ terminate }> once per second or so to slowly replenish the pool. In 249{ terminate }> once per second or so to slowly replenish the pool. In
249addition to that, when the stacks used by a handler grows larger than 16kb 250addition to that, when the stacks used by a handler grows larger than 16kb
266 _pool_2 $cb; 267 _pool_2 $cb;
267 &schedule; 268 &schedule;
268 } 269 }
269 }; 270 };
270 271
272 if ($@) {
271 last if $@ eq "\3async_pool terminate\2\n"; 273 last if $@ eq "\3async_pool terminate\2\n";
272 warn $@ if $@; 274 warn $@;
275 }
273 } 276 }
274} 277}
275 278
276sub async_pool(&@) { 279sub async_pool(&@) {
277 # this is also inlined into the unlock_scheduler 280 # this is also inlined into the unlock_scheduler
307This makes C<schedule> I<the> generic method to use to block the current 310This makes C<schedule> I<the> generic method to use to block the current
308coroutine and wait for events: first you remember the current coroutine in 311coroutine and wait for events: first you remember the current coroutine in
309a variable, then arrange for some callback of yours to call C<< ->ready 312a variable, then arrange for some callback of yours to call C<< ->ready
310>> on that once some event happens, and last you call C<schedule> to put 313>> on that once some event happens, and last you call C<schedule> to put
311yourself to sleep. Note that a lot of things can wake your coroutine up, 314yourself to sleep. Note that a lot of things can wake your coroutine up,
312so you need to check wether the event indeed happened, e.g. by storing the 315so you need to check whether the event indeed happened, e.g. by storing the
313status in a variable. 316status in a variable.
314 317
315The canonical way to wait on external events is this: 318The canonical way to wait on external events is this:
316 319
317 { 320 {
356Kills/terminates/cancels all coroutines except the currently running 359Kills/terminates/cancels all coroutines except the currently running
357one. This is useful after a fork, either in the child or the parent, as 360one. This is useful after a fork, either in the child or the parent, as
358usually only one of them should inherit the running coroutines. 361usually only one of them should inherit the running coroutines.
359 362
360Note that while this will try to free some of the main programs resources, 363Note that while this will try to free some of the main programs resources,
361you cnanot free all of them, so if a coroutine that is not the main 364you cannot free all of them, so if a coroutine that is not the main
362program calls this function, there will be some one-time resource leak. 365program calls this function, there will be some one-time resource leak.
363 366
364=cut 367=cut
365 368
366sub terminate { 369sub terminate {
415once all the coroutines of higher priority and all coroutines of the same 418once all the coroutines of higher priority and all coroutines of the same
416priority that were put into the ready queue earlier have been resumed. 419priority that were put into the ready queue earlier have been resumed.
417 420
418=item $is_ready = $coroutine->is_ready 421=item $is_ready = $coroutine->is_ready
419 422
420Return wether the coroutine is currently the ready queue or not, 423Return whether the coroutine is currently the ready queue or not,
421 424
422=item $coroutine->cancel (arg...) 425=item $coroutine->cancel (arg...)
423 426
424Terminates the given coroutine and makes it return the given arguments as 427Terminates the given coroutine and makes it return the given arguments as
425status (default: the empty list). Never returns if the coroutine is the 428status (default: the empty list). Never returns if the coroutine is the
438 } else { 441 } else {
439 $self->_cancel; 442 $self->_cancel;
440 } 443 }
441} 444}
442 445
446=item $coroutine->throw ([$scalar])
447
448If C<$throw> is specified and defined, it will be thrown as an exception
449inside the coroutine at the next convenient point in time (usually after
450it gains control at the next schedule/transfer/cede). Otherwise clears the
451exception object.
452
453The exception object will be thrown "as is" with the specified scalar in
454C<$@>, i.e. if it is a string, no line number or newline will be appended
455(unlike with C<die>).
456
457This can be used as a softer means than C<cancel> to ask a coroutine to
458end itself, although there is no guarantee that the exception will lead to
459termination, and if the exception isn't caught it might well end the whole
460program.
461
462You might also think of C<throw> as being the moral equivalent of
463C<kill>ing a coroutine with a signal (in this case, a scalar).
464
443=item $coroutine->join 465=item $coroutine->join
444 466
445Wait until the coroutine terminates and return any values given to the 467Wait until the coroutine terminates and return any values given to the
446C<terminate> or C<cancel> functions. C<join> can be called concurrently 468C<terminate> or C<cancel> functions. C<join> can be called concurrently
447from multiple coroutines, and all will be resumed and given the status 469from multiple coroutines, and all will be resumed and given the status
508higher values mean lower priority, just as in unix). 530higher values mean lower priority, just as in unix).
509 531
510=item $olddesc = $coroutine->desc ($newdesc) 532=item $olddesc = $coroutine->desc ($newdesc)
511 533
512Sets (or gets in case the argument is missing) the description for this 534Sets (or gets in case the argument is missing) the description for this
513coroutine. This is just a free-form string you can associate with a coroutine. 535coroutine. This is just a free-form string you can associate with a
536coroutine.
514 537
515This method simply sets the C<< $coroutine->{desc} >> member to the given string. You 538This method simply sets the C<< $coroutine->{desc} >> member to the given
516can modify this member directly if you wish. 539string. You can modify this member directly if you wish.
517
518=item $coroutine->throw ([$scalar])
519
520If C<$throw> is specified and defined, it will be thrown as an exception
521inside the coroutine at the next convinient point in time (usually after
522it gains control at the next schedule/transfer/cede). Otherwise clears the
523exception object.
524
525The exception object will be thrown "as is" with the specified scalar in
526C<$@>, i.e. if it is a string, no line number or newline will be appended
527(unlike with C<die>).
528
529This can be used as a softer means than C<cancel> to ask a coroutine to
530end itself, although there is no guarentee that the exception will lead to
531termination, and if the exception isn't caught it might well end the whole
532program.
533 540
534=cut 541=cut
535 542
536sub desc { 543sub desc {
537 my $old = $_[0]{desc}; 544 my $old = $_[0]{desc};
639 cede; # for short-lived callbacks, this reduces pressure on the coro pool 646 cede; # for short-lived callbacks, this reduces pressure on the coro pool
640 } 647 }
641 schedule; # sleep well 648 schedule; # sleep well
642 } 649 }
643}; 650};
644$unblock_scheduler->desc ("[unblock_sub scheduler]"); 651$unblock_scheduler->{desc} = "[unblock_sub scheduler]";
645 652
646sub unblock_sub(&) { 653sub unblock_sub(&) {
647 my $cb = shift; 654 my $cb = shift;
648 655
649 sub { 656 sub {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines