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

Comparing Coro/Coro.pm (file contents):
Revision 1.141 by root, Tue Oct 2 10:38:17 2007 UTC vs.
Revision 1.145 by root, Wed Oct 3 16:03:17 2007 UTC

… …
50 50
51our $idle; # idle handler 51our $idle; # idle handler
52our $main; # main coroutine 52our $main; # main coroutine
53our $current; # current coroutine 53our $current; # current coroutine
54 54
55our $VERSION = '3.8'; 55our $VERSION = '4.0';
56 56
57our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); 57our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
58our %EXPORT_TAGS = ( 58our %EXPORT_TAGS = (
59 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 59 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
60); 60);
… …
116=cut 116=cut
117 117
118$main->{desc} = "[main::]"; 118$main->{desc} = "[main::]";
119 119
120# maybe some other module used Coro::Specific before... 120# maybe some other module used Coro::Specific before...
121$main->{specific} = $current->{specific} 121$main->{_specific} = $current->{_specific}
122 if $current; 122 if $current;
123 123
124_set_current $main; 124_set_current $main;
125 125
126sub current() { $current } 126sub current() { $current }
… …
151 # free coroutine data and mark as destructed 151 # free coroutine data and mark as destructed
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->{destroy_cb}) || []}; 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;
… …
186=item async { ... } [@args...] 186=item async { ... } [@args...]
187 187
188Create a new asynchronous coroutine and return it's coroutine object 188Create a new asynchronous coroutine and return it's coroutine object
189(usually unused). When the sub returns the new coroutine is automatically 189(usually unused). When the sub returns the new coroutine is automatically
190terminated. 190terminated.
191
192See the C<Coro::State::new> constructor for info about the coroutine
193environment.
191 194
192Calling C<exit> in a coroutine will do the same as calling exit outside 195Calling C<exit> in a coroutine will do the same as calling exit outside
193the coroutine. Likewise, when the coroutine dies, the program will exit, 196the coroutine. Likewise, when the coroutine dies, the program will exit,
194just as it would in the main program. 197just as it would in the main program.
195 198
… …
344Create a new coroutine and return it. When the sub returns the coroutine 347Create a new coroutine and return it. When the sub returns the coroutine
345automatically terminates as if C<terminate> with the returned values were 348automatically terminates as if C<terminate> with the returned values were
346called. To make the coroutine run you must first put it into the ready queue 349called. To make the coroutine run you must first put it into the ready queue
347by calling the ready method. 350by calling the ready method.
348 351
349See C<async> for additional discussion. 352See C<async> and C<Coro::State::new> for additional info about the
353coroutine environment.
350 354
351=cut 355=cut
352 356
353sub _run_coro { 357sub _run_coro {
354 terminate &{+shift}; 358 terminate &{+shift};
… …
378 382
379=cut 383=cut
380 384
381sub cancel { 385sub cancel {
382 my $self = shift; 386 my $self = shift;
383 $self->{status} = [@_]; 387 $self->{_status} = [@_];
384 388
385 if ($current == $self) { 389 if ($current == $self) {
386 push @destroy, $self; 390 push @destroy, $self;
387 $manager->ready; 391 $manager->ready;
388 &schedule while 1; 392 &schedule while 1;
… …
392} 396}
393 397
394=item $coroutine->join 398=item $coroutine->join
395 399
396Wait until the coroutine terminates and return any values given to the 400Wait until the coroutine terminates and return any values given to the
397C<terminate> or C<cancel> functions. C<join> can be called multiple times 401C<terminate> or C<cancel> functions. C<join> can be called concurrently
398from multiple coroutine. 402from multiple coroutines.
399 403
400=cut 404=cut
401 405
402sub join { 406sub join {
403 my $self = shift; 407 my $self = shift;
404 408
405 unless ($self->{status}) { 409 unless ($self->{_status}) {
406 my $current = $current; 410 my $current = $current;
407 411
408 push @{$self->{destroy_cb}}, sub { 412 push @{$self->{_on_destroy}}, sub {
409 $current->ready; 413 $current->ready;
410 undef $current; 414 undef $current;
411 }; 415 };
412 416
413 &schedule while $current; 417 &schedule while $current;
414 } 418 }
415 419
416 wantarray ? @{$self->{status}} : $self->{status}[0]; 420 wantarray ? @{$self->{_status}} : $self->{_status}[0];
417} 421}
418 422
419=item $coroutine->on_destroy (\&cb) 423=item $coroutine->on_destroy (\&cb)
420 424
421Registers a callback that is called when this coroutine gets destroyed, 425Registers a callback that is called when this coroutine gets destroyed,
… …
425=cut 429=cut
426 430
427sub on_destroy { 431sub on_destroy {
428 my ($self, $cb) = @_; 432 my ($self, $cb) = @_;
429 433
430 push @{ $self->{destroy_cb} }, $cb; 434 push @{ $self->{_on_destroy} }, $cb;
431} 435}
432 436
433=item $oldprio = $coroutine->prio ($newprio) 437=item $oldprio = $coroutine->prio ($newprio)
434 438
435Sets (or gets, if the argument is missing) the priority of the 439Sets (or gets, if the argument is missing) the priority of the
… …
459 463
460=item $olddesc = $coroutine->desc ($newdesc) 464=item $olddesc = $coroutine->desc ($newdesc)
461 465
462Sets (or gets in case the argument is missing) the description for this 466Sets (or gets in case the argument is missing) the description for this
463coroutine. This is just a free-form string you can associate with a coroutine. 467coroutine. This is just a free-form string you can associate with a coroutine.
468
469This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
470can modify this member directly if you wish.
464 471
465=cut 472=cut
466 473
467sub desc { 474sub desc {
468 my $old = $_[0]{desc}; 475 my $old = $_[0]{desc};

Diff Legend

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