NAME

Net::Peep::Parser - Perl extension for parsing configuration files for Peep: The Network Auralizer.

SYNOPSIS

  use Net::Peep::Parser;
  my $parser = new Net::Peep::Parser;

  # load returns a Net::Peep::Conf object.  %options conform to
  # the specifications given in Getopt::Long

  my $conf = $parser->load(%options);

  # all of the configuration information in /etc/peep.conf
  # is now available through the observer methods in the
  # Net::Peep::Conf object

DESCRIPTION

Net::Peep::Parser parses a Peep configuration file and returns a Net::Peep::Conf object whose accessors contain all the information found in the configuration file.

Note that the Net::Peep::Parser class exists solely to allow the 0.5.x configuration scheme to retain backwards-compatibility with 0.4.x configuration files.

The 0.4.x style configurations will likely be deprecated as of the 0.6.x series.

As such, there are many kludgy parts of this class. Apologies in advance to anyone who has to work with it, but it will likey soon be a throwaway.

METHODS

  load(%options) - loads configuration information found in the file
  $options{'config'} .  Returns a Net::Peep::Conf object.

  parseConfig($config) - parses the configuration file $config.

  parseClass($filehandle,$classname) - parses the class definition
  section of a configuration file.

  parseClient($filehandle,$client) - parses the client definition
  section of a configuration file.

  parseEvents($filehandle) - parses the event definition section of a
  configuration file.

  parseState($filehandle) - parses the state definition section of a
  configuration file.

  parseClientEvents($filehandle) - parses the client event definition
  section of a configuration file.

  parseClientDefault($filehandle) - parses the client defaults section
  of a configuration file.

  logger() - returns a Net::Peep::Log object for logging and
  debugging.

  conf() - gets/sets a Net::Peep::Conf object for storing and
  retrieving configuration information.

AUTHOR

CHANGE LOG

$Log: Parser.pm,v $ Revision 1.11 2002/06/13 07:01:58 starky Themes are now (mostly) working. Some work remains on the server side before they can be fully tested.

Revision 1.10 2002/06/10 04:51:19 starky Removed dependencies on Net::Peep::Data::Conf::Class::Broadcast and Net::Peep::Data::Conf::Class::Broadcasts classes, which have been deprecated due to changes in the configuration file.

Revision 1.9 2002/06/08 03:22:37 starky With a variety of fixes, autodiscovery is (almost) working normally.

Revision 1.8 2002/05/23 07:40:17 starky First commit of a working 0.5.x pinger.

Revision 1.7 2002/05/14 05:47:21 starky An interim checking while getting sysmonitor and pinger in order. Lots of stuff is still broken. Hopefully all of the clients will be converted and working real soon now ....

Revision 1.6 2002/03/13 02:11:26 starky With this commit 100.t, a test script for text-based Peep configuration, passes all tests.

Revision 1.5 2002/03/06 17:33:42 starky Bugfixes too numerous to mention.

Revision 1.4 2002/02/26 06:01:10 starky Test script 100.t now passes all tests. Some work with the configuration and parsing still needs to be done, as well as XML imports. Progress continues ....

Revision 1.3 2002/02/25 05:43:47 starky First commit that builds the full client base for 0.5.x and passes regression tests < 100.t.

Revision 1.2 2002/01/14 16:21:04 starky Checking in (currently broken) code for the 0.5.x release for others (e.g., Michael) to take a gander at.

Revision 1.1 2001/10/18 06:01:34 starky Initial commit of client libraries for version 0.5.0.

Revision 1.6 2001/10/01 05:20:05 starky Hopefully the final commit before release 0.4.4. Tied up some minor issues, did some beautification of the log messages, added some comments, and made other minor changes.

Revision 1.5 2001/09/23 08:53:57 starky The initial checkin of the 0.4.4 release candidate 1 clients. The release includes (but is not limited to): o A new client: pinger o A greatly expanded sysmonitor client o An API for creating custom clients o Extensive documentation on creating custom clients o Improved configuration file format o E-mail notifications Contact Collin at collin.starkweather@colorado with any questions.

Revision 1.4 2001/08/08 20:17:57 starky Check in of code for the 0.4.3 client release. Includes modifications to allow for backwards-compatibility to Perl 5.00503 and a critical bug fix to the 0.4.2 version of Net::Peep::Conf.

Revision 1.3 2001/08/06 04:20:36 starky Fixed bug #447844.

Revision 1.2 2001/07/23 17:46:29 starky Added versioning to the configuration file as well as the ability to specify groups in addition to / as a replacement for event letters. Also changed the Net::Peep::Parse namespace to Net::Peep::Parser. (I don't know why I ever named an object by a verb!)

Revision 1.1 2001/07/23 16:18:35 starky Changed the namespace of Net::Peep::Parse to Net::Peep::Parser. (Why did I ever create an object whose namespace was a verb anyway?!?) This file was consequently moved from peep/client/Net/Peep/Parse to its current location.

Net::Peep::Parser