EII ConfigMgr C/C++ Reference
Public Member Functions | List of all members
eii::config_manager::ConfigMgr Class Reference

#include <config_mgr.hpp>

Public Member Functions

 ConfigMgr ()
 
AppCfggetAppConfig ()
 
int getNumPublishers ()
 
int getNumSubscribers ()
 
int getNumServers ()
 
int getNumClients ()
 
bool isDevMode ()
 
std::string getAppName ()
 
ServerCfggetServerByIndex (int index)
 
ServerCfggetServerByName (const char *name)
 
ClientCfggetClientByIndex (int index)
 
ClientCfggetClientByName (const char *name)
 
PublisherCfggetPublisherByIndex (int index)
 
PublisherCfggetPublisherByName (const char *name)
 
SubscriberCfggetSubscriberByIndex (int index)
 
SubscriberCfggetSubscriberByName (const char *name)
 
 ~ConfigMgr ()
 

Detailed Description

ConfigMgr class

Constructor & Destructor Documentation

◆ ConfigMgr()

eii::config_manager::ConfigMgr::ConfigMgr ( )

Constructor To instantiate main ConfigMgr object

◆ ~ConfigMgr()

eii::config_manager::ConfigMgr::~ConfigMgr ( )

Destructor

Member Function Documentation

◆ getAppConfig()

AppCfg* eii::config_manager::ConfigMgr::getAppConfig ( )

gets app related configs from ConfigManager

Returns
AppCfg* - AppCfg class object

◆ getAppName()

std::string eii::config_manager::ConfigMgr::getAppName ( )

Get the AppName for any service

Returns
std::string - AppName string

◆ getClientByIndex()

ClientCfg* eii::config_manager::ConfigMgr::getClientByIndex ( int  index)

Get client interface using it's index

Parameters
index- These clients are in array for which index is sent to get the respective client config.
Returns
ClientCfg* - ClientCfg class object

◆ getClientByName()

ClientCfg* eii::config_manager::ConfigMgr::getClientByName ( const char *  name)

Get client interface using it's name

Parameters
name- These clients are in array for which name is sent to get the respective client config.
Returns
ClientCfg* - ClientCfg class object

◆ getNumClients()

int eii::config_manager::ConfigMgr::getNumClients ( )

Get total number of clients in an interface

Returns
int - number of client interfaces

◆ getNumPublishers()

int eii::config_manager::ConfigMgr::getNumPublishers ( )

Get total number of publishers in an interface

Returns
int - number of publisher interfaces

◆ getNumServers()

int eii::config_manager::ConfigMgr::getNumServers ( )

Get total number of servers in an interface

Returns
int - number of server interfaces

◆ getNumSubscribers()

int eii::config_manager::ConfigMgr::getNumSubscribers ( )

Get total number of subscribers in an interface

Returns
int - number of subscriber interfaces

◆ getPublisherByIndex()

PublisherCfg* eii::config_manager::ConfigMgr::getPublisherByIndex ( int  index)

Get publisher interface using it's index

Parameters
index- These publishers are in array for which index is sent to get the respective publisher config.
Returns
PublisherCfg* - PublisherCfg class object

◆ getPublisherByName()

PublisherCfg* eii::config_manager::ConfigMgr::getPublisherByName ( const char *  name)

Get publisher interface using it's name

Parameters
name- These publishers are in array for which name is sent to get the respective publisher config.
Returns
PublisherCfg* - PublisherCfg class object

◆ getServerByIndex()

ServerCfg* eii::config_manager::ConfigMgr::getServerByIndex ( int  index)

Get server interface using it's index

Parameters
index- These servers are in array for which index is sent to get the respective server config.
Returns
ServerCfg* - ServerCfg class object

◆ getServerByName()

ServerCfg* eii::config_manager::ConfigMgr::getServerByName ( const char *  name)

Get server interface using it's name

Parameters
name- These servers are in array for which name is sent to get the respective server config.
Returns
ServerCfg* - ServerCfg class object

◆ getSubscriberByIndex()

SubscriberCfg* eii::config_manager::ConfigMgr::getSubscriberByIndex ( int  index)

Get subscriber interface using it's index

Parameters
index- These subscribers are in array for which name is sent to get the respective subscriber config.
Returns
SubscriberCfg* - SubscriberCfg class object

◆ getSubscriberByName()

SubscriberCfg* eii::config_manager::ConfigMgr::getSubscriberByName ( const char *  name)

Get subscriber interface using it's name

Parameters
name- These subscribers are in array for which name is sent to get the respective subscriber config.
Returns
SubscriberCfg* - SubscriberCfg class object

◆ isDevMode()

bool eii::config_manager::ConfigMgr::isDevMode ( )

To check if application is running in dev or prod mode

Returns
bool - True if dev mode & false if prod mode

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