|
NAMEPipeline - Generic pipeline interfaceSYNOPSISuse Pipeline; my $pipeline = Pipeline->new(); $pipeline->add_segment( @segments ); $pipeline->dispatch(); DESCRIPTION"Pipelines" are a mechanism to process data. They are designed to be plugged together to make fairly complex operations act in a fairly straightforward manner, cleanly, and simply.USING THE PIPELINE MODULEThe usage of the generic pipeline module is fairly simple. You instantiate a Pipeline object by using the new() constructor.Segments can be added to the pipeline with the add_segment method. The store that the Pipeline will use can be set by calling the store() method later on. If a store is not set by the time a pipeline is executing then it will use a store of the type "Pipeline::Store::Simple". To start the pipeline running call the dispatch() method on your Pipeline object. If a segment returns a Pipeline::Production object then the pipeline will be terminated early and the production will be returned to the user. Regardless of when the pipeline is terminated the pipeline's cleanup pipeline is executed. Segments can be added to the cleanup pipeline either explicitly by calling the cleanups method to get the cleanup pipeline and then adding the segment, or implicitly by returning a segment object from a segment. To see what is being dispatched within a pipeline dispatch set the pipeline's debug_all value to true. INHERITANCEPipelines are designed to be inherited from. The inheritance tree is somewhat warped and should look a little like this:MySegment --> Pipeline::Segment <--- Pipeline In other words, everything is a pipeline segment. METHODSThe Pipeline class inherits from the "Pipeline::Segment" class and therefore also has any additional methods that its superclass may have.
SEE ALSO"Pipeline::Segment", "Pipeline::Store", "Pipeline::Store::Simple" "Pipeline::Production", "Pipeline::Dispatch"AUTHORSJames A. Duncan <jduncan@fotango.com> Leon Brocard <acme@astray.com> COPYRIGHTCopyright 2003 Fotango Ltd. Licensed under the same terms as Perl itself.
Visit the GSP FreeBSD Man Page Interface. |