server::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 &	GetSmScxmlAppendFilename () const
const std::string &	GetConfigFilename () const
const std::string &	GetProcName () const
const std::string &	GetLogLevel () const
const std::string &	GetLogProperties () 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 &	GetSmScxmlAppendFilename () const
const std::string &	GetConfigFilename () const
const std::string &	GetProcName () const
const std::string &	GetLogLevel () const
const std::string &	GetLogProperties () 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

Config() [1/4]

server::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)

~Config() [1/2]

server::Config::~Config ( )

virtual

Default destructor.

Config() [2/4]

server::Config::Config ( const Config &  )

delete

Config() [3/4]

server::Config::Config

(

)

~Config() [2/2]

virtual server::Config::~Config ( )

virtual

Config() [4/4]

server::Config::Config ( const Config &  )

delete

Member Function Documentation

GetConfigFilename() [1/2]

const std::string & server::Config::GetConfigFilename

(

)

const

Returns

The application configuration filename.

GetConfigFilename() [2/2]

const std::string& server::Config::GetConfigFilename

(

)

const

GetDbEndpoint() [1/2]

const std::string & server::Config::GetDbEndpoint

(

)

const

Returns

The IP address used to connect to the runtime DB.

GetDbEndpoint() [2/2]

const std::string& server::Config::GetDbEndpoint

(

)

const

GetDbTimeout() [1/2]

const timeval server::Config::GetDbTimeout

(

)

const

Returns

The timeout used when communicating to the runtime DB.

GetDbTimeout() [2/2]

const timeval server::Config::GetDbTimeout

(

)

const

GetLogLevel() [1/2]

const std::string & server::Config::GetLogLevel

(

)

const

Returns

The configured log level.

GetLogLevel() [2/2]

const std::string& server::Config::GetLogLevel

(

)

const

GetLogProperties() [1/2]

const std::string & server::Config::GetLogProperties

(

)

const

Returns

The configured log properties filename.

GetLogProperties() [2/2]

const std::string& server::Config::GetLogProperties

(

)

const

GetMsgReplierEndpoint() [1/2]

const std::string & server::Config::GetMsgReplierEndpoint

(

)

const

Returns

The network endpoint to send request to this application.

The format is "tcp://ipaddr:port", for example: "tcp://127.0.0.1:5577"

GetMsgReplierEndpoint() [2/2]

const std::string& server::Config::GetMsgReplierEndpoint

(

)

const

GetMsgSubEndpoint() [1/2]

const std::string & server::Config::GetMsgSubEndpoint

(

)

const

Returns

The endpoint for the topic subscription.

GetMsgSubEndpoint() [2/2]

const std::string& server::Config::GetMsgSubEndpoint

(

)

const

GetProcName() [1/2]

const std::string & server::Config::GetProcName

(

)

const

Returns

The application process name.

GetProcName() [2/2]

const std::string& server::Config::GetProcName

(

)

const

GetSmScxmlAppendFilename() [1/2]

const std::string & server::Config::GetSmScxmlAppendFilename

(

)

const

Returns

The additional/appended SCXML State Machine model filename used by the application.

GetSmScxmlAppendFilename() [2/2]

const std::string& server::Config::GetSmScxmlAppendFilename

(

)

const

GetSmScxmlFilename() [1/2]

const std::string & server::Config::GetSmScxmlFilename

(

)

const

Returns

The SCXML State Machine model filename used by the application.

GetSmScxmlFilename() [2/2]

const std::string& server::Config::GetSmScxmlFilename

(

)

const

LoadConfig() [1/2]

void server::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.

LoadConfig() [2/2]

void server::Config::LoadConfig

(

const std::string &

filename = ""

)

operator=() [1/2]

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

delete

Disable copy constructor.

operator=() [2/2]

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

delete

Disable copy constructor.

ParseOptions() [1/2]

bool server::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.

ParseOptions() [2/2]

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

---

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

• INTROOT/sources/rad/cpp/_examples/server/src/config.hpp
• INTROOT/sources/rad/cpp/_examples/server/src/config.cpp