NAME

IO::Pipe::Producer

AUTHOR

IO::Pipe::Producer was written by Robert W. Leach <robleach@lanl.gov> in 2005.

SYNOPSIS

 # Module which provides 2 methods: getSubroutineProducer
 # and getSystemProducer.  They take a subroutine reference
 # (with associated arguments) and a system call
 # respectively and return (blessed) handles on their
 # streaming standard output and standard error output.
 
 
 # EXAMPLES of usage
 
 use IO::Pipe::Producer;
 $obj = new IO::Pipe::Producer();
 $stdout_fh =
   $obj->getSubroutineProducer($subroutine_reference,
                               @subroutine_parameters);
 
 # OR
 
 use IO::Pipe::Producer;
 $obj = new IO::Pipe::Producer();
 ($stdout_fh,$stderr_fh) =
   $obj->getSubroutineProducer($subroutine_reference,
                               @subroutine_parameters);
 
 # OR
 
 use IO::Pipe::Producer;
 $stdout_fh = new IO::Pipe::Producer($subroutine_reference,
                                    @subroutine_parameters);
 
 # OR
 
 use IO::Pipe::Producer;
 ($stdout_fh,$stderr_fh) =
   new IO::Pipe::Producer($subroutine_reference,
                          @subroutine_parameters);
 
 # Then you can read the returned handles like any other
 # file handle...
 
 while(<$stdout_fh>)
   {print "STDOUT From Producer: $_"}
 while(<$stderr_fh>)
   {print "STDERR From Producer: $_"}
 
 # You can also do the same thing with system calls using
 # the getSystemProducer subroutine.  However, this feature
 # is not accessible via the new constructor
 
 use IO::Pipe::Producer;
 $obj = new IO::Pipe::Producer();
 $stdout_fh =
   $obj->getSystemProducer("echo \"Hello World!\"");
 
 use IO::Pipe::Producer;
 $obj = new IO::Pipe::Producer();
 ($stdout_fh,$stderr_fh) =
   $obj->getSystemProducer("echo \"Hello World!\"");
 
 # However, this is exactly the same as:
 
 use IO::Pipe::Producer;
 $stdout_fh = new Producer(sub{system(@_)},
                           "echo \"Hello World!\"");
 
 # OR
 
 use IO::Pipe::Producer;
 ($stdout_fh,$stderr_fh) =
   new IO::Pipe::Producer(sub{system(@_)},
                          "echo \"Hello World!\"");
 

ABSTRACT

Producer.pm is useful for piggy-backing large data processing subroutines or system calls. Instead of making each call serially and waiting for a return or playing with temporary files, you can create a Producer that will continuosly generate output that can be further processed right away in your script. One benefit is immediate feedback. It's basically a way to pipe the standard output of a forked subroutine or system call to a file handle in your parent process.

DESCRIPTION

Producer.pm is a module that provides methods to fork off a subroutine or system call and return handles on the standard output (STDOUT and STDERR). If you have (for example) a subroutine that processes a very large text file and performs a task on each line, but you need to perform further processing with either other subroutines or in main, normally you would have to wait until the subroutine returns to get its output (either by returning it or opening a temporary file that it produced) and continue processing. If the subroutine prints its output to STDOUT (and STDERR) or you can edit it to do so, you can call it using a Producer so that you can use the returned handle to continuously process each line as it's "produced". You can chain subroutines together like this by having your subroutine itself create a Producer. This is similar to using open() to run a system call, except that with this module, you can get a handle on STDERR and use it with subroutines as well.

NOTES

This module was originally written as a simple subrotuine in a library that simply used IO::Pipe. I decided to make it into a subclass of IO::Pipe even though it only really adds one method and a helper method (Note: The getSystemProducer method calls getSubroutineProducer) because libraries seem antiquated to me. I'm open to better design suggestions however. I also decided to bless the returns of all the methods because they were retuning IO::Pipe objects anyway. The basic trick this module uses can be gleaned from the IO::Pipe documentation if you read between the lines and combine various tidbits from different sections, but to simplify it, it simply "opens" the file handle inside the IO::Pipe data structure to accept output from the output file handles (STDOUT/STDERR) as input, which is the basic definition of a pipe.

NOTICE

This software and ancillary information (herein called "SOFTWARE") called Producer.pm is made available under the terms described here. The SOFTWARE has been approved for release with associated LA-CC number LA-CC-05-060.

Unless otherwise indicated, this software has been authored by an employee or employees of the University of California, operator of the Los Alamos National Laboratory under Contract No. W-7405-ENG-36 with the U.S. Department of Energy. The U.S. government has rights to use, reproduce, and distribute this SOFTWARE. The public may copy, distribute, prepare derivative works and publicly display this SOFTWARE without charge, provided that this notice and any statement of authorship are reproduced on all copies. Neither the government nor the university makes any warranty, express or implied, or assumes any liability or responsibility for the use of this SOFTWARE.

If SOFTWARE is modified to produce derivative works, such modified SOFTWARE should be clearly marked, so as not to confuse it with the version available from LANL.

BUGS

No known bugs. Please report them to <robleach@lanl.gov> if you find any.

SEE ALSO

IO::Pipe