1. Manuals
  2. Tumbleweed
  3. liblog4shib-devel
  4. log4shib::SimpleConfigurator(3)

Scroll to navigation

log4shib::SimpleConfigurator(3) Library Functions Manual log4shib::SimpleConfigurator(3)

NAME

log4shib::SimpleConfigurator - This class implements a simple Configurator for log4shib.

SYNOPSIS

#include <SimpleConfigurator.hh>

Static Public Member Functions


static void configure (const std::string &initFileName)
Configure log4shib with the configuration in the given file. static void configure (std::istream &initFile)
Configure log4shib with the configuration in the given file.

Detailed Description

This class implements a simple Configurator for log4shib.

It is a temporary hack with an undocumented configuration format.

Deprecated

As of version 0.3.2 log4shib includes a log4j format compatible PropertyConfigurator, removing the need for SimpleConfigurator. This class will be removed in 0.4.0.

Member Function Documentation

void log4shib::SimpleConfigurator::configure (const std::string & initFileName) [static]

Configure log4shib with the configuration in the given file. NB. The configuration file format is undocumented and may change without notice.

Since

0.2.6

Parameters

initFileName name of the configuration file

Exceptions

ConfigureFailure if the method encountered a read or syntax error.

void log4shib::SimpleConfigurator::configure (std::istream & initFile) [static]

Configure log4shib with the configuration in the given file. NB. The configuration file format is undocumented and may change without notice.

Since

0.3.1

Parameters

initFile an input stream to the configuration file

Exceptions

ConfigureFailure if the method encountered a read or syntax error.

Author

Generated automatically by Doxygen for log4shib from the source code.

Version 2.0.1 log4shib