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

Comparing Coro/Coro.pm (file contents):
Revision 1.140 by root, Thu Sep 27 16:25:10 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
… …
308 311
309=item terminate [arg...] 312=item terminate [arg...]
310 313
311Terminates the current coroutine with the given status values (see L<cancel>). 314Terminates the current coroutine with the given status values (see L<cancel>).
312 315
316=item killall
317
318Kills/terminates/cancels all coroutines except the currently running
319one. This is useful after a fork, either in the child or the parent, as
320usually only one of them should inherit the running coroutines.
321
313=cut 322=cut
314 323
315sub terminate { 324sub terminate {
316 $current->cancel (@_); 325 $current->cancel (@_);
326}
327
328sub killall {
329 for (Coro::State::list) {
330 $_->cancel
331 if $_ != $current && UNIVERSAL::isa $_, "Coro";
332 }
317} 333}
318 334
319=back 335=back
320 336
321# dynamic methods 337# dynamic methods
… …
331Create 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
332automatically terminates as if C<terminate> with the returned values were 348automatically terminates as if C<terminate> with the returned values were
333called. 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
334by calling the ready method. 350by calling the ready method.
335 351
336See C<async> for additional discussion. 352See C<async> and C<Coro::State::new> for additional info about the
353coroutine environment.
337 354
338=cut 355=cut
339 356
340sub _run_coro { 357sub _run_coro {
341 terminate &{+shift}; 358 terminate &{+shift};
… …
365 382
366=cut 383=cut
367 384
368sub cancel { 385sub cancel {
369 my $self = shift; 386 my $self = shift;
370 $self->{status} = [@_]; 387 $self->{_status} = [@_];
371 388
372 if ($current == $self) { 389 if ($current == $self) {
373 push @destroy, $self; 390 push @destroy, $self;
374 $manager->ready; 391 $manager->ready;
375 &schedule while 1; 392 &schedule while 1;
… …
379} 396}
380 397
381=item $coroutine->join 398=item $coroutine->join
382 399
383Wait until the coroutine terminates and return any values given to the 400Wait until the coroutine terminates and return any values given to the
384C<terminate> or C<cancel> functions. C<join> can be called multiple times 401C<terminate> or C<cancel> functions. C<join> can be called concurrently
385from multiple coroutine. 402from multiple coroutines.
386 403
387=cut 404=cut
388 405
389sub join { 406sub join {
390 my $self = shift; 407 my $self = shift;
391 408
392 unless ($self->{status}) { 409 unless ($self->{_status}) {
393 my $current = $current; 410 my $current = $current;
394 411
395 push @{$self->{destroy_cb}}, sub { 412 push @{$self->{_on_destroy}}, sub {
396 $current->ready; 413 $current->ready;
397 undef $current; 414 undef $current;
398 }; 415 };
399 416
400 &schedule while $current; 417 &schedule while $current;
401 } 418 }
402 419
403 wantarray ? @{$self->{status}} : $self->{status}[0]; 420 wantarray ? @{$self->{_status}} : $self->{_status}[0];
404} 421}
405 422
406=item $coroutine->on_destroy (\&cb) 423=item $coroutine->on_destroy (\&cb)
407 424
408Registers a callback that is called when this coroutine gets destroyed, 425Registers a callback that is called when this coroutine gets destroyed,
… …
412=cut 429=cut
413 430
414sub on_destroy { 431sub on_destroy {
415 my ($self, $cb) = @_; 432 my ($self, $cb) = @_;
416 433
417 push @{ $self->{destroy_cb} }, $cb; 434 push @{ $self->{_on_destroy} }, $cb;
418} 435}
419 436
420=item $oldprio = $coroutine->prio ($newprio) 437=item $oldprio = $coroutine->prio ($newprio)
421 438
422Sets (or gets, if the argument is missing) the priority of the 439Sets (or gets, if the argument is missing) the priority of the
… …
446 463
447=item $olddesc = $coroutine->desc ($newdesc) 464=item $olddesc = $coroutine->desc ($newdesc)
448 465
449Sets (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
450coroutine. 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.
451 471
452=cut 472=cut
453 473
454sub desc { 474sub desc {
455 my $old = $_[0]{desc}; 475 my $old = $_[0]{desc};

Diff Legend

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