rad  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
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
 
Configoperator= (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
 
Configoperator= (const Config &)=delete
 Disable copy constructor. More...
 

Detailed Description

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

Constructor & Destructor Documentation

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)
server::Config::~Config ( )
virtual

Default destructor.

server::Config::Config ( const Config )
delete
server::Config::Config ( )
virtual server::Config::~Config ( )
virtual
server::Config::Config ( const Config )
delete

Member Function Documentation

const std::string & server::Config::GetConfigFilename ( ) const
Returns
The application configuration filename.
const std::string& server::Config::GetConfigFilename ( ) const
const std::string& server::Config::GetDbEndpoint ( ) const
const std::string & server::Config::GetDbEndpoint ( ) const
Returns
The IP address used to connect to the runtime DB.
const timeval server::Config::GetDbTimeout ( ) const
const timeval server::Config::GetDbTimeout ( ) const
Returns
The timeout used when communicating to the runtime DB.
const std::string & server::Config::GetLogLevel ( ) const
Returns
The configured log level.
const std::string& server::Config::GetLogLevel ( ) const
const std::string& server::Config::GetLogProperties ( ) const
const std::string & server::Config::GetLogProperties ( ) const
Returns
The configured log properties filename.
const std::string& server::Config::GetMsgReplierEndpoint ( ) const
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"

const std::string& server::Config::GetMsgSubEndpoint ( ) const
const std::string & server::Config::GetMsgSubEndpoint ( ) const
Returns
The endpoint for the topic subscription.
const std::string & server::Config::GetProcName ( ) const
Returns
The application process name.
const std::string& server::Config::GetProcName ( ) const
const std::string & server::Config::GetSmScxmlAppendFilename ( ) const
Returns
The additional/appended SCXML State Machine model filename used by the application.
const std::string& server::Config::GetSmScxmlAppendFilename ( ) const
const std::string& server::Config::GetSmScxmlFilename ( ) const
const std::string & server::Config::GetSmScxmlFilename ( ) const
Returns
The SCXML State Machine model filename used by the application.
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]filenameApplication configuration filename.
void server::Config::LoadConfig ( const std::string &  filename = "")
Config& server::Config::operator= ( const Config )
delete

Disable copy constructor.

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

Disable copy constructor.

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

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

Parameters
[in]argcNumber of command line options.
[in]argvPointer to the array of command line options.
Returns
false if the help option has been invoked, true otherwise.

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