_Wolframe::config::ServiceBanner Class Reference

Service signature. More...

#include <standardConfigs.hpp>

Inheritance diagram for _Wolframe::config::ServiceBanner:

Public Types
enum	SignatureTokens {   PRODUCT_NAME, VERSION_MAJOR, VERSION_MINOR, VERSION_REVISION,   VERSION_BUILD, PRODUCT_OS, NONE, UNDEFINED }

Public Member Functions
	ServiceBanner ()
	constructor More...
std::string	toString () const
	methods More...
bool	parse (const config::ConfigurationNode &pt, const std::string &node, const module::ModulesDirectory *modules)
	Parse the configuration section. More...
bool	check () const
void	print (std::ostream &os, size_t indent) const
Public Member Functions inherited from _Wolframe::config::ConfigurationBase
	ConfigurationBase (const char *sectionName_, const char *logParent_, const char *logName_)
virtual	~ConfigurationBase ()
const std::string &	sectionName () const
	The display string (name) for the configuration section. More...
const std::string &	logPrefix () const
virtual void	setCanonicalPathes (const std::string &)

Protected Attributes
SignatureTokens	m_tokens
	data members More...
std::string	m_serverSignature

Friends
class	ConfigurationParser

Detailed Description

Service signature.

Member Enumeration Documentation

enum _Wolframe::config::ServiceBanner::SignatureTokens

Enumerator
PRODUCT_NAME
VERSION_MAJOR
VERSION_MINOR
VERSION_REVISION
VERSION_BUILD
PRODUCT_OS
NONE
UNDEFINED

Constructor & Destructor Documentation

_Wolframe::config::ServiceBanner::ServiceBanner ( )

inline

constructor

Member Function Documentation

bool _Wolframe::config::ServiceBanner::check ( ) const

virtual

Check if the server configuration makes sense

Be aware that this function does NOT test if the configuration can be used. It only tests if it MAY be valid. This function will log errors / warnings

Returns

true if the configuration has no errors, false otherwise

Reimplemented from _Wolframe::config::ConfigurationBase.

bool _Wolframe::config::ServiceBanner::parse ( const config::ConfigurationNode &  cfgTree, const std::string &  node, const module::ModulesDirectory *  modules  )

virtual

Parse the configuration section.

Parameters

[in]	pt	property tree node
[in]	node	the label of the node. It should be the same (case insensitive) as it->first

Implements _Wolframe::config::ConfigurationBase.

void _Wolframe::config::ServiceBanner::print ( std::ostream &  os, size_t  indent  ) const

virtual

Print the configuration This function is supposed to print the running configuration, this means all the configuration parameters, not only those that were set in the configuration file.

Parameters

[in]	os	stream to use for printing
[in]	indent	print indented with this number of spaces

Implements _Wolframe::config::ConfigurationBase.

std::string _Wolframe::config::ServiceBanner::toString

(

)

const

methods

Friends And Related Function Documentation

friend class ConfigurationParser

friend

Member Data Documentation

std::string _Wolframe::config::ServiceBanner::m_serverSignature

protected

SignatureTokens _Wolframe::config::ServiceBanner::m_tokens

protected

data members

---

The documentation for this class was generated from the following file:

• include/standardConfigs.hpp