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

Comparing Coro/Coro.pm (file contents):
Revision 1.135 by root, Sat Sep 22 22:39:15 2007 UTC vs.
Revision 1.148 by root, Fri Oct 5 20:11:25 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.7'; 55our $VERSION = '4.01';
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
… …
216issued in case of an exception instead of terminating the program, as 219issued in case of an exception instead of terminating the program, as
217C<async> does. As the coroutine is being reused, stuff like C<on_destroy> 220C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
218will not work in the expected way, unless you call terminate or cancel, 221will not work in the expected way, unless you call terminate or cancel,
219which somehow defeats the purpose of pooling. 222which somehow defeats the purpose of pooling.
220 223
221The priority will be reset to C<0> after each job, otherwise the coroutine 224The priority will be reset to C<0> after each job, tracing will be
222will be re-used "as-is". 225disabled, the description will be reset and the default output filehandle
226gets restored, so you can change alkl these. Otherwise the coroutine will
227be re-used "as-is": most notably if you change other per-coroutine global
228stuff such as C<$/> you need to revert that change, which is most simply
229done by using local as in C< local $/ >.
223 230
224The pool size is limited to 8 idle coroutines (this can be adjusted by 231The pool size is limited to 8 idle coroutines (this can be adjusted by
225changing $Coro::POOL_SIZE), and there can be as many non-idle coros as 232changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
226required. 233required.
227 234
… …
241 my $cb; 248 my $cb;
242 249
243 while () { 250 while () {
244 eval { 251 eval {
245 while () { 252 while () {
246# &{&_pool_1 or &terminate}; # crashes, would be ~5% faster
247 $cb = &_pool_1 253 _pool_1 $cb;
248 or &terminate;
249 &$cb; 254 &$cb;
250 undef $cb; 255 _pool_2 $cb;
251 &terminate if &_pool_2;
252 &schedule; 256 &schedule;
253 } 257 }
254 }; 258 };
255 259
260 last if $@ eq "\3terminate\2\n";
256 warn $@ if $@; 261 warn $@ if $@;
257 } 262 }
258} 263}
259 264
260sub async_pool(&@) { 265sub async_pool(&@) {
… …
310 315
311=item terminate [arg...] 316=item terminate [arg...]
312 317
313Terminates the current coroutine with the given status values (see L<cancel>). 318Terminates the current coroutine with the given status values (see L<cancel>).
314 319
320=item killall
321
322Kills/terminates/cancels all coroutines except the currently running
323one. This is useful after a fork, either in the child or the parent, as
324usually only one of them should inherit the running coroutines.
325
315=cut 326=cut
316 327
317sub terminate { 328sub terminate {
318 $current->cancel (@_); 329 $current->cancel (@_);
330}
331
332sub killall {
333 for (Coro::State::list) {
334 $_->cancel
335 if $_ != $current && UNIVERSAL::isa $_, "Coro";
336 }
319} 337}
320 338
321=back 339=back
322 340
323# dynamic methods 341# dynamic methods
… …
333Create a new coroutine and return it. When the sub returns the coroutine 351Create a new coroutine and return it. When the sub returns the coroutine
334automatically terminates as if C<terminate> with the returned values were 352automatically terminates as if C<terminate> with the returned values were
335called. To make the coroutine run you must first put it into the ready queue 353called. To make the coroutine run you must first put it into the ready queue
336by calling the ready method. 354by calling the ready method.
337 355
338See C<async> for additional discussion. 356See C<async> and C<Coro::State::new> for additional info about the
357coroutine environment.
339 358
340=cut 359=cut
341 360
342sub _run_coro { 361sub _run_coro {
343 terminate &{+shift}; 362 terminate &{+shift};
… …
367 386
368=cut 387=cut
369 388
370sub cancel { 389sub cancel {
371 my $self = shift; 390 my $self = shift;
372 $self->{status} = [@_]; 391 $self->{_status} = [@_];
373 392
374 if ($current == $self) { 393 if ($current == $self) {
375 push @destroy, $self; 394 push @destroy, $self;
376 $manager->ready; 395 $manager->ready;
377 &schedule while 1; 396 &schedule while 1;
… …
381} 400}
382 401
383=item $coroutine->join 402=item $coroutine->join
384 403
385Wait until the coroutine terminates and return any values given to the 404Wait until the coroutine terminates and return any values given to the
386C<terminate> or C<cancel> functions. C<join> can be called multiple times 405C<terminate> or C<cancel> functions. C<join> can be called concurrently
387from multiple coroutine. 406from multiple coroutines.
388 407
389=cut 408=cut
390 409
391sub join { 410sub join {
392 my $self = shift; 411 my $self = shift;
393 412
394 unless ($self->{status}) { 413 unless ($self->{_status}) {
395 my $current = $current; 414 my $current = $current;
396 415
397 push @{$self->{destroy_cb}}, sub { 416 push @{$self->{_on_destroy}}, sub {
398 $current->ready; 417 $current->ready;
399 undef $current; 418 undef $current;
400 }; 419 };
401 420
402 &schedule while $current; 421 &schedule while $current;
403 } 422 }
404 423
405 wantarray ? @{$self->{status}} : $self->{status}[0]; 424 wantarray ? @{$self->{_status}} : $self->{_status}[0];
406} 425}
407 426
408=item $coroutine->on_destroy (\&cb) 427=item $coroutine->on_destroy (\&cb)
409 428
410Registers a callback that is called when this coroutine gets destroyed, 429Registers a callback that is called when this coroutine gets destroyed,
… …
414=cut 433=cut
415 434
416sub on_destroy { 435sub on_destroy {
417 my ($self, $cb) = @_; 436 my ($self, $cb) = @_;
418 437
419 push @{ $self->{destroy_cb} }, $cb; 438 push @{ $self->{_on_destroy} }, $cb;
420} 439}
421 440
422=item $oldprio = $coroutine->prio ($newprio) 441=item $oldprio = $coroutine->prio ($newprio)
423 442
424Sets (or gets, if the argument is missing) the priority of the 443Sets (or gets, if the argument is missing) the priority of the
… …
448 467
449=item $olddesc = $coroutine->desc ($newdesc) 468=item $olddesc = $coroutine->desc ($newdesc)
450 469
451Sets (or gets in case the argument is missing) the description for this 470Sets (or gets in case the argument is missing) the description for this
452coroutine. This is just a free-form string you can associate with a coroutine. 471coroutine. This is just a free-form string you can associate with a coroutine.
472
473This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
474can modify this member directly if you wish.
453 475
454=cut 476=cut
455 477
456sub desc { 478sub desc {
457 my $old = $_[0]{desc}; 479 my $old = $_[0]{desc};
… …
575 to allow per-thread schedulers, but Coro::State does not yet allow 597 to allow per-thread schedulers, but Coro::State does not yet allow
576 this). 598 this).
577 599
578=head1 SEE ALSO 600=head1 SEE ALSO
579 601
580Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. 602Support/Utility: L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
581 603
582Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. 604Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
583 605
584Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. 606Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
585 607

Diff Legend

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