[ViewVC] Diff of: cvs/cvsroot/Coro/Coro.pm

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.141 by root, Tue Oct 2 10:38:17 2007 UTC vs.
Revision 1.178 by root, Thu Apr 17 22:33:10 2008 UTC

  use Coro;
  async {
     # some asynchronous thread of execution
+    print "2\n";
+    cede; # yield back to main
+    print "4\n";
  };
+ print "1\n";
+ cede; # yield to coroutine
+ print "3\n";
+ cede; # and again
- # alternatively create an async coroutine like this:
+ # use locking
+ my $lock = new Coro::Semaphore;
+ my $locked;
- sub some_func : Coro {
+ $lock->down;
-    # some more async code
+ $locked = 1;
- }
+ $lock->up;
- cede;
 =head1 DESCRIPTION
 This module collection manages coroutines. Coroutines are similar
 to threads but don't run in parallel at the same time even on SMP
 is a performance win on Windows machines, and a loss everywhere else).
 In this module, coroutines are defined as "callchain + lexical variables +
 @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
 its own set of lexicals and its own set of perls most important global
-variables.
+variables (see L<Coro::State> for more configuration).
 =cut
 package Coro;
 our $idle;    # idle handler
 our $main;    # main coroutine
 our $current; # current coroutine
-our $VERSION = '3.8';
+our $VERSION = '4.51';
 our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
 our %EXPORT_TAGS = (
       prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
 );
 =cut
 $main->{desc} = "[main::]";
 # maybe some other module used Coro::Specific before...
-$main->{specific} = $current->{specific}
+$main->{_specific} = $current->{_specific}
    if $current;
 _set_current $main;
 sub current() { $current }
 This hook is overwritten by modules such as C<Coro::Timer> and
 C<Coro::Event> to wait on an external event that hopefully wake up a
 coroutine so the scheduler can run it.
 Please note that if your callback recursively invokes perl (e.g. for event
-handlers), then it must be prepared to be called recursively.
+handlers), then it must be prepared to be called recursively itself.
 =cut
 $idle = sub {
    require Carp;
    # free coroutine data and mark as destructed
    $self->_destroy
       or return;
    # call all destruction callbacks
-   $_->(@{$self->{status}})
+   $_->(@{$self->{_status}})
-      for @{(delete $self->{destroy_cb}) || []};
+      for @{(delete $self->{_on_destroy}) || []};
 }
 # this coroutine is necessary because a coroutine
 # cannot destroy itself.
 my @destroy;
    }
 };
 $manager->desc ("[coro manager]");
 $manager->prio (PRIO_MAX);
-# static methods. not really.
 =back
 =head2 STATIC METHODS
 Static methods are actually functions that operate on the current coroutine only.
 =item async { ... } [@args...]
 Create a new asynchronous coroutine and return it's coroutine object
 (usually unused). When the sub returns the new coroutine is automatically
 terminated.
+See the C<Coro::State::new> constructor for info about the coroutine
+environment in which coroutines run.
 Calling C<exit> in a coroutine will do the same as calling exit outside
 the coroutine. Likewise, when the coroutine dies, the program will exit,
 just as it would in the main program.
 issued in case of an exception instead of terminating the program, as
 C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
 will not work in the expected way, unless you call terminate or cancel,
 which somehow defeats the purpose of pooling.
-The priority will be reset to C<0> after each job, otherwise the coroutine
+The priority will be reset to C<0> after each job, tracing will be
-will be re-used "as-is".
+disabled, the description will be reset and the default output filehandle
+gets restored, so you can change alkl these. Otherwise the coroutine will
+be re-used "as-is": most notably if you change other per-coroutine global
+stuff such as C<$/> you need to revert that change, which is most simply
+done by using local as in C< local $/ >.
 The pool size is limited to 8 idle coroutines (this can be adjusted by
 changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
 required.
             _pool_2 $cb;
             &schedule;
          }
       };
-      last if $@ eq "\3terminate\2\n";
+      last if $@ eq "\3async_pool terminate\2\n";
       warn $@ if $@;
    }
 }
 sub async_pool(&@) {
 "Cede" to other coroutines. This function puts the current coroutine into the
 ready queue and calls C<schedule>, which has the effect of giving up the
 current "timeslice" to other coroutines of the same or higher priority.
-Returns true if at least one coroutine switch has happened.
 =item Coro::cede_notself
 Works like cede, but is not exported by default and will cede to any
 coroutine, regardless of priority, once.
-Returns true if at least one coroutine switch has happened.
 =item terminate [arg...]
 Terminates the current coroutine with the given status values (see L<cancel>).
    }
 }
 =back
-# dynamic methods
 =head2 COROUTINE METHODS
 These are the methods you can call on coroutine objects.
 =over 4
 Create a new coroutine and return it. When the sub returns the coroutine
 automatically terminates as if C<terminate> with the returned values were
 called. To make the coroutine run you must first put it into the ready queue
 by calling the ready method.
-See C<async> for additional discussion.
+See C<async> and C<Coro::State::new> for additional info about the
+coroutine environment.
 =cut
 sub _run_coro {
    terminate &{+shift};
 =cut
 sub cancel {
    my $self = shift;
-   $self->{status} = [@_];
+   $self->{_status} = [@_];
    if ($current == $self) {
       push @destroy, $self;
       $manager->ready;
       &schedule while 1;
 }
 =item $coroutine->join
 Wait until the coroutine terminates and return any values given to the
-C<terminate> or C<cancel> functions. C<join> can be called multiple times
+C<terminate> or C<cancel> functions. C<join> can be called concurrently
-from multiple coroutine.
+from multiple coroutines.
 =cut
 sub join {
    my $self = shift;
-   unless ($self->{status}) {
+   unless ($self->{_status}) {
       my $current = $current;
-      push @{$self->{destroy_cb}}, sub {
+      push @{$self->{_on_destroy}}, sub {
          $current->ready;
          undef $current;
       };
       &schedule while $current;
    }
-   wantarray ? @{$self->{status}} : $self->{status}[0];
+   wantarray ? @{$self->{_status}} : $self->{_status}[0];
 }
 =item $coroutine->on_destroy (\&cb)
 Registers a callback that is called when this coroutine gets destroyed,
 =cut
 sub on_destroy {
    my ($self, $cb) = @_;
-   push @{ $self->{destroy_cb} }, $cb;
+   push @{ $self->{_on_destroy} }, $cb;
 }
 =item $oldprio = $coroutine->prio ($newprio)
 Sets (or gets, if the argument is missing) the priority of the
 =item $olddesc = $coroutine->desc ($newdesc)
 Sets (or gets in case the argument is missing) the description for this
 coroutine. This is just a free-form string you can associate with a coroutine.
+This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
+can modify this member directly if you wish.
+=item $coroutine->throw ([$scalar])
+If C<$throw> is specified and defined, it will be thrown as an exception
+inside the coroutine at the next convinient point in time (usually after
+it gains control at the next schedule/transfer/cede). Otherwise clears the
+exception object.
+The exception object will be thrown "as is" with the specified scalar in
+C<$@>, i.e. if it is a string, no line number or newline will be appended
+(unlike with C<die>).
+This can be used as a softer means than C<cancel> to ask a coroutine to
+end itself, although there is no guarentee that the exception will lead to
+termination, and if the exception isn't caught it might well end the whole
+program.
 =cut
 sub desc {
    my $old = $_[0]{desc};
    to allow per-thread schedulers, but Coro::State does not yet allow
    this).
 =head1 SEE ALSO
+Lower level Configuration, Coroutine Environment: L<Coro::State>.
+Debugging: L<Coro::Debug>.
-Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
+Support/Utility: L<Coro::Specific>, L<Coro::Util>.
 Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
-Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
+Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>.
+Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>.
-Embedding: L<Coro:MakeMaker>
+Embedding: L<Coro::MakeMaker>.
 =head1 AUTHOR
  Marc Lehmann <schmorp@schmorp.de>
  http://home.schmorp.de/

Diff Legend

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

Comparing cvsroot/Coro/Coro.pm (file contents): Revision 1.141 by root, Tue Oct 2 10:38:17 2007 UTC vs. Revision 1.178 by root, Thu Apr 17 22:33:10 2008 UTC

Diff Legend

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.141 by root, Tue Oct 2 10:38:17 2007 UTC vs.
Revision 1.178 by root, Thu Apr 17 22:33:10 2008 UTC