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

Comparing Coro/Coro.pm (file contents):
Revision 1.202 by root, Tue Sep 30 17:12:34 2008 UTC vs.
Revision 1.214 by root, Tue Nov 11 03:30:21 2008 UTC

56 56
57=cut 57=cut
58 58
59package Coro; 59package Coro;
60 60
61use strict; 61use strict qw(vars subs);
62no warnings "uninitialized"; 62no warnings "uninitialized";
63 63
64use Coro::State; 64use Coro::State;
65 65
66use base qw(Coro::State Exporter); 66use base qw(Coro::State Exporter);
67 67
68our $idle; # idle handler 68our $idle; # idle handler
69our $main; # main coroutine 69our $main; # main coroutine
70our $current; # current coroutine 70our $current; # current coroutine
71 71
72our $VERSION = 4.8; 72our $VERSION = 4.911;
73 73
74our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); 74our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
75our %EXPORT_TAGS = ( 75our %EXPORT_TAGS = (
76 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)],
77); 77);
152 $self->_destroy 152 $self->_destroy
153 or return; 153 or return;
154 154
155 # call all destruction callbacks 155 # call all destruction callbacks
156 $_->(@{$self->{_status}}) 156 $_->(@{$self->{_status}})
157 for @{(delete $self->{_on_destroy}) || []}; 157 for @{ delete $self->{_on_destroy} || [] };
158} 158}
159 159
160# this coroutine is necessary because a coroutine 160# this coroutine is necessary because a coroutine
161# cannot destroy itself. 161# cannot destroy itself.
162my @destroy; 162my @destroy;
168 while @destroy; 168 while @destroy;
169 169
170 &schedule; 170 &schedule;
171 } 171 }
172}; 172};
173$manager->desc ("[coro manager]"); 173$manager->{desc} = "[coro manager]";
174$manager->prio (PRIO_MAX); 174$manager->prio (PRIO_MAX);
175 175
176=back 176=back
177 177
178=head2 SIMPLE COROUTINE CREATION 178=head2 SIMPLE COROUTINE CREATION
221terminate 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
222coroutine that might have executed other code already (which can be good 222coroutine that might have executed other code already (which can be good
223or bad :). 223or bad :).
224 224
225On the plus side, this function is faster than creating (and destroying) 225On the plus side, this function is faster than creating (and destroying)
226a 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
227quick successsion, use C<async_pool>, not C<async>. 227quick successsion, use C<async_pool>, not C<async>.
228 228
229The 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
230issued in case of an exception instead of terminating the program, as 230issued in case of an exception instead of terminating the program, as
231C<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>
235 235
236The 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
237disabled, the description will be reset and the default output filehandle 237disabled, the description will be reset and the default output filehandle
238gets restored, so you can change all these. Otherwise the coroutine will 238gets restored, so you can change all these. Otherwise the coroutine will
239be 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
240stuff 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
241simply done by using local as in: C< local $/ >. 241simply done by using local as in: C<< local $/ >>.
242 242
243The 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
244changing $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
245required. 245coros as required.
246 246
247If you are concerned about pooled coroutines growing a lot because a 247If you are concerned about pooled coroutines growing a lot because a
248single 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
249{ 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
250addition 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
441 } else { 441 } else {
442 $self->_cancel; 442 $self->_cancel;
443 } 443 }
444} 444}
445 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
446=item $coroutine->join 465=item $coroutine->join
447 466
448Wait until the coroutine terminates and return any values given to the 467Wait until the coroutine terminates and return any values given to the
449C<terminate> or C<cancel> functions. C<join> can be called concurrently 468C<terminate> or C<cancel> functions. C<join> can be called concurrently
450from multiple coroutines, and all will be resumed and given the status 469from multiple coroutines, and all will be resumed and given the status
511higher values mean lower priority, just as in unix). 530higher values mean lower priority, just as in unix).
512 531
513=item $olddesc = $coroutine->desc ($newdesc) 532=item $olddesc = $coroutine->desc ($newdesc)
514 533
515Sets (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
516coroutine. 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.
517 537
518This 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
519can modify this member directly if you wish. 539string. You can modify this member directly if you wish.
520
521=item $coroutine->throw ([$scalar])
522
523If C<$throw> is specified and defined, it will be thrown as an exception
524inside the coroutine at the next convinient point in time (usually after
525it gains control at the next schedule/transfer/cede). Otherwise clears the
526exception object.
527
528The exception object will be thrown "as is" with the specified scalar in
529C<$@>, i.e. if it is a string, no line number or newline will be appended
530(unlike with C<die>).
531
532This can be used as a softer means than C<cancel> to ask a coroutine to
533end itself, although there is no guarentee that the exception will lead to
534termination, and if the exception isn't caught it might well end the whole
535program.
536 540
537=cut 541=cut
538 542
539sub desc { 543sub desc {
540 my $old = $_[0]{desc}; 544 my $old = $_[0]{desc};
642 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
643 } 647 }
644 schedule; # sleep well 648 schedule; # sleep well
645 } 649 }
646}; 650};
647$unblock_scheduler->desc ("[unblock_sub scheduler]"); 651$unblock_scheduler->{desc} = "[unblock_sub scheduler]";
648 652
649sub unblock_sub(&) { 653sub unblock_sub(&) {
650 my $cb = shift; 654 my $cb = shift;
651 655
652 sub { 656 sub {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines