server2::Config Class Reference

#include <Config.hpp>

Public Member Functions
	Config ()
virtual	~Config ()
bool	ParseOptions (int argc, char *argv[])
void	LoadConfig (const std::string &filename="")
const std::string &	GetMsgReplierEndpoint () const
const std::string &	GetMsgSubEndpoint () const
const std::string &	GetDbEndpoint () const
const timeval	GetDbTimeout () const
const std::string &	GetSmScxmlFilename () const
const std::string &	GetConfigFilename () const
const std::string &	GetProcName () const
const std::string &	GetLogLevel () const
	Config (const Config &)=delete
Config &	operator= (const Config &)=delete
	Disable copy constructor. More...
	Config ()
virtual	~Config ()
bool	ParseOptions (int argc, char *argv[])
void	LoadConfig (const std::string &filename="")
const std::string &	GetMsgReplierEndpoint () const
const std::string &	GetMsgSubEndpoint () const
const std::string &	GetDbEndpoint () const
const timeval	GetDbTimeout () const
const std::string &	GetSmScxmlFilename () const
const std::string &	GetConfigFilename () const
const std::string &	GetProcName () const
const std::string &	GetLogLevel () const
	Config (const Config &)=delete
Config &	operator= (const Config &)=delete
	Disable copy constructor. More...

Detailed Description

This class provide access to the following application read-only configuration information:

• default constant configuration values
• environment variable configuration values
• command line options
• configuration parameters stored in the configuration file.

Constructor & Destructor Documentation

server2::Config::Config

(

)

Default constructor.

Initialize application configuration attributes by

• first use the default constant values defined in the header
• override the constant values with environment variables (if defined)

server2::Config::~Config ( )

virtual

Default destructor.

server2::Config::Config ( const Config &  )

delete

server2::Config::Config

(

)

virtual server2::Config::~Config ( )

virtual

server2::Config::Config ( const Config &  )

delete

Member Function Documentation

const std::string & server2::Config::GetConfigFilename

(

)

const

Returns

The application configuration filename.

const std::string& server2::Config::GetConfigFilename

(

)

const

const std::string & server2::Config::GetDbEndpoint

(

)

const

Returns

The IP address used to connect to the runtime DB.

const std::string& server2::Config::GetDbEndpoint

(

)

const

const timeval server2::Config::GetDbTimeout

(

)

const

const timeval server2::Config::GetDbTimeout

(

)

const

Returns

The timeout used when communicating to the runtime DB.

const std::string & server2::Config::GetLogLevel

(

)

const

Returns

The configured log level.

const std::string& server2::Config::GetLogLevel

(

)

const

const std::string & server2::Config::GetMsgReplierEndpoint

(

)

const

Returns

The network endpoint to send request to this application. The format is "<protocol>://<ipaddr>:<port>" where <protocol> is 'tcp' For example: "tcp://127.0.0.1:5577"

const std::string& server2::Config::GetMsgReplierEndpoint

(

)

const

const std::string & server2::Config::GetMsgSubEndpoint

(

)

const

Returns

The endpoint for the topic subscription.

const std::string& server2::Config::GetMsgSubEndpoint

(

)

const

const std::string & server2::Config::GetProcName

(

)

const

Returns

The application process name.

const std::string& server2::Config::GetProcName

(

)

const

const std::string& server2::Config::GetSmScxmlFilename

(

)

const

const std::string & server2::Config::GetSmScxmlFilename

(

)

const

Returns

The SCXML State Machine model filename used by the application.

void server2::Config::LoadConfig

(

const std::string &

filename = ""

)

void server2::Config::LoadConfig

(

const std::string &

filename = ""

)

This method load from a configuration file the application configuration overriding the initialization done in the constructor and the command line options.

Parameters

[in]

filename

Application configuration filename.

Config& server2::Config::operator= ( const Config &  )

delete

Disable copy constructor.

Config& server2::Config::operator= ( const Config &  )

delete

Disable copy constructor.

bool server2::Config::ParseOptions	(	int	argc,
		char *	argv[]
	)

This method parses the command line parameters overriding the initialization done in the constructor.

Parameters

[in]	argc	Number of command line options.
[in]	argv	Pointer to the array of command line options.

Returns

false if the help option has been invoked, true otherwise.

bool server2::Config::ParseOptions	(	int	argc,
		char *	argv[]
	)

---

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

• INTROOT/sources/tools/rad/cpp/_examples/server2/src/Config.hpp
• tools/rad/cpp/_examples/server2/src/Config.hpp
• INTROOT/sources/tools/rad/cpp/_examples/server2/src/Config.cpp
• tools/rad/cpp/_examples/server2/src/Config.cpp