1Pipeline::Segment(3)  User Contributed Perl Documentation Pipeline::Segment(3)
2
3
4

NAME

6       Pipeline::Segment - basic class for a segment
7

SYNOPSIS

9         use Pipeline::Segment;
10         my $ps = Pipeline::Segment->new();
11         $ps->dispatch();
12

DESCRIPTION

14       "Pipeline::Segment" is designed as a part of the "Pipeline" system.
15       The "Pipeline::Segment" class is designed to be subclassed as a part of
16       the Pipeline system.  The primary method that needs to be overloaded is
17       the "dispatch" method, which the Pipeline class uses to enter each
18       individual segment that it contains.
19

METHODS

21       The "Pipeline::Segment" class inherits from "Pipeline::Base" and
22       therefore also has any additional methods that its superclass may have.
23
24       init()
25           The "init" method is called at construction time.  Any arguments
26           passed to the "new" method are passed to it.
27
28       dispatch()
29           The "dispatch" method causes the segment to perform its action.
30
31       dispatch_method()
32           The "dispatch_method" gets and sets the method that gets called on
33           dispatch, by default this is the dispatch() method.
34
35       cleanup_dispatch()
36           The "cleanup_dispatch" method does post-processing on the segment
37           to ensure no nasty circular references are lying around, as well as
38           disconnecting various objects that are only useful during a
39           dispatch.
40
41       store()
42           The "store" method gets the current store.
43
44       parent()
45           The "parent" method returns the pipeline that the segment is
46           current operating from.  It is set at dispatch time by the calling
47           pipeline.
48

SEE ALSO

50       "Pipeline", "Pipeline::Segment::Async"
51

AUTHOR

53       James A. Duncan <jduncan@fotango.com>
54

56       Copyright 2003 Fotango Ltd. All Rights Reserved.
57
58       This software is released under the same terms as Perl itself.
59
60
61
62perl v5.38.0                      2023-07-21              Pipeline::Segment(3)
Impressum