Unix::ConfigFile 0.06

The Unix::ConfigFile module provides a base class from which the other Unix::*File modules are derived. It provides some basic facilities like file opening, locking, and closing. You do not need to use this module directly unless you are developing a derived module for an unsupported configuration file. However, some of the methods documented here are intended for public use by users of Unix::ConfigFile submodules, so you may find this documentation useful even if you are not developing your own module.<br /><br />The ConfigFile object also provides a sequencing API for modules that wish to preserve the order of the configuration file they read and write. The sequencer maintains a list of arbitrary data that a submodule may append, insert, and delete from. Use of the sequencer is completely optional.<br /><br />A module that subclasses from Unix::ConfigFile must, at a minimum, provide two methods, called "read" and "write". Both methods will receive a filehandle as a parameter (besides the regular object parameter). The read method is called after the file is opened. It is expected to read in the configuration file and initialize the subclass-specific data structures associated with the object. The write method is called when an object is committed and is expected to write out the new configuration to the supplied filehandle.

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Called,  Completely,  Configuration,  Derived,  Developing,  Expected,  Filehandle,  Method,  Methods,  Module,  Modules,  Object,  Optionala,  Parameter,  Sequencer,  Structures,  Subclasses,  Unixconfigfile,  Write
Users rating:	0/10