NAME

LCFG::Component - Perl module for LCFG Generic component

VERSION

This documentation refers to LCFG::Component version 1.6.0

DESCRIPTION

This module provides a superclass for creating LCFG components in Perl.

Components should subclass LCFG::Component, create a new instance of the class, and call the Dispatch method to execute the component method specified in the command line arguments. The LCFG component perlex shows how this is used in practice.

LCFG::Component attempts to provide an identical functionality to the shell generic component ngeneric.

FUNCTIONS

Equivalent Perl functions are provided for all the method functions described in lcfg-ngeneric. A hash of resource values is passed as the first argument to each function, rather than passing the resources in the environment.

GetSysInfo

Returns a reference to an LCFG::SysInfo object. This object can be used to discover information about the current platform (e.g. os, architecture) and the location of standard LCFG paths. See LCFG::SysInfo documentation for full details.

RESOURCES, LOCKING and LOG ROTATING

See the documentation for the ngeneric component.

VARIABLES

All the variables described for lcfg-ngeneric have equivalent instance variables in the LCFG::Component class.

AD-HOC METHODS

Methods with names of the form Method_methodname, will be automatically called by the Dispatch function. Ad-hoc methods should arrange to call the Lock function if appropriate to prevent simultaneous method calls.

SEE ALSO

lcfg-ngeneric

The shell generic functions.

lcfg-perlex

An example component.

LCFG::Template

The template processor.

LCFG::Resources

The resource handling functions.

PLATFORMS

Fedora13, Scientific5, Scientific6

AUTHOR

Paul Anderson <dcspaul@inf.ed.ac.uk>

LICENSE AND COPYRIGHT

Copyright (C) 2007-2013 by University of Edinburgh

This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.