GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Pipeline::Base(3) User Contributed Perl Documentation Pipeline::Base(3)

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

  use Pipeline::Base;

  $object = Pipeline::Base->new()
  $object->debug( 10 );
  $object->emit("message");

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

CLASS->new()
The "new()" method is a constructor that returns an instance of receiving class.
init( LIST );
"init()" is called by the constructor, "new()" and is passed all of its arguments in LIST.
debug( [ SCALAR ] )
The "debug()" method gets and sets the debug state of the OBJECT. Setting it to a true value will cause messages sent to "emit()" to be printed to the terminal. If debug() is called as a class method it always will return true.
emit( SCALAR )
"emit()" is a debugging tool. It will cause the the SCALAR to be formatted and sent to the "log()" method if the current debugging level is set to a true value.
log( SCALAR )
The "log()" method will send SCALAR to STDERR by default. It performs no processing of SCALAR and merely sends its results to the error handle. To change your logging mechanism simply override this method in the class as you see fit.

James A. Duncan <jduncan@fotango.com>
2004-08-09 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.