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

NAME

6       Pipeline::Base - base class for all classes in Pipeline distribution
7

SYNOPSIS

9         use Pipeline::Base;
10
11         $object = Pipeline::Base->new()
12         $object->debug( 10 );
13         $object->emit("message");
14

DESCRIPTION

16       "Pipeline::Base" is a class that provides a basic level of
17       functionality for all classes in the Pipeline system.  Most importantly
18       it provides the construction and initialization of new objects.
19

METHODS

21       CLASS->new()
22           The new() method is a constructor that returns an instance of
23           receiving class.
24
25       init( LIST );
26           init() is called by the constructor, new() and is passed all of its
27           arguments in LIST.
28
29       debug( [ SCALAR ] )
30           The debug() method gets and sets the debug state of the OBJECT.
31           Setting it to a true value will cause messages sent to emit() to be
32           printed to the terminal.  If debug() is called as a class method it
33           always will return true.
34
35       emit( SCALAR )
36           emit() is a debugging tool.  It will cause the the SCALAR to be
37           formatted and sent to the log() method if the current debugging
38           level is set to a true value.
39
40       log( SCALAR )
41           The log() method will send SCALAR to STDERR by default.  It
42           performs no processing of SCALAR and merely sends its results to
43           the error handle.  To change your logging mechanism simply override
44           this method in the class as you see fit.
45

AUTHOR

47       James A. Duncan <jduncan@fotango.com>
48
49
50
51perl v5.36.0                      2023-01-20                 Pipeline::Base(3)