[ViewVC] Diff of: cvs/AnyEvent-Fork/Fork.pm

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.49 by root, Fri Apr 19 12:56:53 2013 UTC vs.
Revision 1.55 by root, Fri Apr 26 23:24:30 2013 UTC

 If you need some form of RPC, you could use the L<AnyEvent::Fork::RPC>
 companion module, which adds simple RPC/job queueing to a process created
 by this module.
+And if you need some automatic process pool management on top of
+L<AnyEvent::Fork::RPC>, you can look at the L<AnyEvent::Fork::Pool>
+companion module.
-Or you can implement it yourself in whatever way you like, use some
+Or you can implement it yourself in whatever way you like: use some
 message-passing module such as L<AnyEvent::MP>, some pipe such as
 L<AnyEvent::ZeroMQ>, use L<AnyEvent::Handle> on both sides to send
 e.g. JSON or Storable messages, and so on.
 =head2 COMPARISON TO OTHER MODULES
       ->send_arg ("/bin/echo", "hi")
       ->run ("run", my $cv = AE::cv);
    my $stderr = $cv->recv;
+=head2 For stingy users: put the worker code into a C<DATA> section.
+When you want to be stingy with files, you cna put your code into the
+C<DATA> section of your module (or program):
+   use AnyEvent::Fork;
+   AnyEvent::Fork
+      ->new
+      ->eval (do { local $/; <DATA> })
+      ->run ("doit", sub { ... });
+   __DATA__
+   sub doit {
+      ... do something!
+   }
+=head2 For stingy standalone programs: do not rely on external files at
+all.
+For single-file scripts it can be inconvenient to rely on external
+files - even when using < C<DATA> section, you still need to C<exec>
+an external perl interpreter, which might not be available when using
+L<App::Staticperl>, L<Urlader> or L<PAR::Packer> for example.
+Two modules help here - L<AnyEvent::Fork::Early> forks a template process
+for all further calls to C<new_exec>, and L<AnyEvent::Fork::Template>
+forks the main program as a template process.
+Here is how your main program should look like:
+   #! perl
+   # optional, as the very first thing.
+   # in case modules want to create their own processes.
+   use AnyEvent::Fork::Early;
+   # next, load all modules you need in your template process
+   use Example::My::Module
+   use Example::Whatever;
+   # next, put your run function definition and anything else you
+   # need, but do not use code outside of BEGIN blocks.
+   sub worker_run {
+      my ($fh, @args) = @_;
+      ...
+   }
+   # now preserve everything so far as AnyEvent::Fork object
+   # in §TEMPLATE.
+   use AnyEvent::Fork::Template;
+   # do not put code outside of BEGIN blocks until here
+   # now use the $TEMPLATE process in any way you like
+   # for example: create 10 worker processes
+   my @worker;
+   my $cv = AE::cv;
+   for (1..10) {
+      $cv->begin;
+      $TEMPLATE->fork->send_arg ($_)->run ("worker_run", sub {
+         push @worker, shift;
+         $cv->end;
+      });
+   }
+   $cv->recv;
 =head1 CONCEPTS
 This module can create new processes either by executing a new perl
 process, or by forking from an existing "template" process.
 use AnyEvent;
 use AnyEvent::Util ();
 use IO::FDPass;
-our $VERSION = 0.7;
+our $VERSION = '1.0';
 # the early fork template process
 our $EARLY;
 # the empty template process
             # send string
             my $len = syswrite $self->[FH], $self->[QUEUE][0];
             unless ($len) {
                return if $! == Errno::EAGAIN || $! == Errno::EWOULDBLOCK;
-               undef $self->[3];
+               undef $self->[WW];
                die "AnyEvent::Fork: command write failure: $!";
             }
             substr $self->[QUEUE][0], 0, $len, "";
             shift @{ $self->[QUEUE] } unless length $self->[QUEUE][0];
    $self->[CB] = $cb;
    $self->_cmd (r => $func);
 }
-=item $proc->to_fh ($cb->($fh))
+=back
+=head2 EXPERIMENTAL METHODS
+These methods might go away completely or change behaviour, at any time.
+=over 4
+=item $proc->to_fh ($cb->($fh))    # EXPERIMENTAL, MIGHT BE REMOVED
 Flushes all commands out to the process and then calls the callback with
 the communications socket.
 The process object becomes unusable on return from this function - any
 further method calls result in undefined behaviour.
 The point of this method is to give you a file handle thta you cna pass
 to another process. In that other process, you can call C<new_from_fh
-AnyEvent::Fork::RPC> to create a new C<AnyEvent::Fork> object from it,
+AnyEvent::Fork> to create a new C<AnyEvent::Fork> object from it, thereby
-thereby effectively passing a fork object to another process.
+effectively passing a fork object to another process.
 =cut
 sub to_fh {
    my ($self, $cb) = @_;
       $self->[CB]->($self->[FH]);
       @$self = ();
    }
 }
-=item new_from_fh AnyEvent::Fork $fh
+=item new_from_fh AnyEvent::Fork $fh    # EXPERIMENTAL, MIGHT BE REMOVED
 Takes a file handle originally rceeived by the C<to_fh> method and creates
 a new C<AnyEvent:Fork> object. The child process itself will not change in
 any way, i.e. it will keep all the modifications done to it before calling
 C<to_fh>.
 L<AnyEvent::Fork::Template>, to create a process by forking the main
 program at a convenient time (part of this distribution).
 L<AnyEvent::Fork::RPC>, for simple RPC to child processes (on CPAN).
+L<AnyEvent::Fork::Pool>, for simple worker process pool (on CPAN).
 =head1 AUTHOR AND CONTACT INFORMATION
  Marc Lehmann <schmorp@schmorp.de>
  http://software.schmorp.de/pkg/AnyEvent-Fork

Diff Legend

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

Comparing AnyEvent-Fork/Fork.pm (file contents): Revision 1.49 by root, Fri Apr 19 12:56:53 2013 UTC vs. Revision 1.55 by root, Fri Apr 26 23:24:30 2013 UTC

Diff Legend

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.49 by root, Fri Apr 19 12:56:53 2013 UTC vs.
Revision 1.55 by root, Fri Apr 26 23:24:30 2013 UTC