Mark Howe > Xcruciate > Xcruciate::XcruciateConfig

Download:
Xcruciate-0.21.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.21   Source  

NAME ^

Xcruciate::XcruciateConfig - OO API for reading xcruciate config files.

SYNOPSIS ^

my $config=Xcruciate::XcruciateConfig->new('xcruciate.conf');

my $xacd_path=$config->xacd_path;

my @unit_paths=$config->unit_config_files;

DESCRIPTION ^

Xcruciate::XcruciateConfig is part of the Xcruciate project (http://www.xcruciate.co.uk). It provides an OO interface to an xcruciate configuration file.

The methods all take an optional verbose argument. If this is perlishly true the methods will show their working to STDOUT.

At present the methods look for configuration errors and die noisily if they find any. This is useful behaviour for management scripts - continuing to set up server daemons on the basis of broken configurations is not best practice - but non-fatal error reporting could be provided if/when an application requires it.

AUTHOR ^

Mark Howe, <melonman@cpan.org>

EXPORT

None

METHODS ^

new(config_file_path [,verbose])

Creates and returns an Xcruciate::XcruciateConfig object which can then be queried.

xcr_file_format_description()

Returns multi-lined human-friendly description of the xcr config file

restart_sleep()

Returns the time to sleep for between stopping and starting during a restart.

start_test_sleep()

Returns the time to sleep for between starting a process and checking that it started correctly.

stop_test_sleep()

Returns the time to sleep for between killing a process and checking that it died.

xacd_path()

Returns the path to the xacd executable.

xted_path()

Returns the path to the xted executable.

mxmlc_path()

Returns the path to the mxmlc (Flex 3) executable.

fop_path()

Returns the path to the fop executable.

xmlroff_path()

Returns the path to the xmlroff executable.

unit_config_files()

Returns a list of paths to Xacerbate configuration files.

local_croak()

Function for croaking

BUGS ^

The best way to report bugs is via the Xcruciate bugzilla site (http://www.xcruciate.co.uk/bugzilla).

PREVIOUS VERSIONS ^

0.01: First upload

0.03: First upload containing module

0.04: Changed minimum perl version to 5.8.8

0.05: Warn about unknown entries

0.07: Attempt to put all Xcruciate modules in one PAUSE tarball

0.08: Global version upgrade

0.09: Made most entries optional. Use Carp for errors

0.10: Prepend path entry to relative paths

0.12: Improvise Xcruciate config file if provided with Unit config file

0.14: Global update

0.16: Global update

0.17: use warnings

0.18: Global update

0.19: Use XML Schema durations

0.20: Optional paths for fop, mxmlc and xmlroff

COPYRIGHT AND LICENSE ^

Copyright (C) 2007 - 2009 by SARL Cyberporte/Menteith Consulting

This library is distributed under BSD licence (http://www.xcruciate.co.uk/licence-code).

syntax highlighting: