EII ConfigMgr C/C++ Reference
Public Member Functions | List of all members
eii::config_manager::PublisherCfg Class Reference
Inheritance diagram for eii::config_manager::PublisherCfg:
eii::config_manager::AppCfg

Public Member Functions

 PublisherCfg (cfgmgr_interface_t *cfgmgr_interface)
 
config_t * getMsgBusConfig () override
 
std::string getEndpoint () override
 
config_value_t * getInterfaceValue (const char *key) override
 
std::vector< std::string > getTopics () override
 
bool setTopics (std::vector< std::string > topics_list) override
 
std::vector< std::string > getAllowedClients () override
 
cfgmgr_interface_tgetPubCfg ()
 
 ~PublisherCfg ()
 
- Public Member Functions inherited from eii::config_manager::AppCfg
 AppCfg (cfgmgr_ctx_t *cfgmgr)
 
config_t * getConfig ()
 
config_t * getInterface ()
 
config_value_t * getConfigValue (const char *key)
 
bool watch (const char *key, cfgmgr_watch_callback_t watch_callback, void *user_data)
 
bool watchPrefix (char *prefix, cfgmgr_watch_callback_t watch_callback, void *user_data)
 
bool watchConfig (cfgmgr_watch_callback_t watch_callback, void *user_data)
 
bool watchInterface (cfgmgr_watch_callback_t watch_callback, void *user_data)
 
virtual ~AppCfg ()
 

Additional Inherited Members

- Protected Member Functions inherited from eii::config_manager::AppCfg
std::vector< std::string > tokenizer (const char *str, const char *delim)
 

Constructor & Destructor Documentation

◆ PublisherCfg()

eii::config_manager::PublisherCfg::PublisherCfg ( cfgmgr_interface_t cfgmgr_interface)
explicit

PublisherCfg Constructor This constructor is not to be directly called since it is only used internally by the ConfigMgr

Parameters
cfgmgr_interface- The interface associated with a publisher

◆ ~PublisherCfg()

eii::config_manager::PublisherCfg::~PublisherCfg ( )

Destructor

Member Function Documentation

◆ getAllowedClients()

std::vector<std::string> eii::config_manager::PublisherCfg::getAllowedClients ( )
overridevirtual

To get the names of the clients allowed to get publishers data

Returns
vector<string> - On Success, Allowed client of publisher config
  • On Failure, returns empty vector

Reimplemented from eii::config_manager::AppCfg.

◆ getEndpoint()

std::string eii::config_manager::PublisherCfg::getEndpoint ( )
overridevirtual

To get endpoint for particular publisher from it's interface config

Returns
std::string - On Success, returns Endpoint of server config
  • On Failure, returns empty string

Reimplemented from eii::config_manager::AppCfg.

◆ getInterfaceValue()

config_value_t* eii::config_manager::PublisherCfg::getInterfaceValue ( const char *  key)
overridevirtual

To get particular interface value from Publisher interface config

Parameters
key- Key on which interface value is extracted.
Returns
config_value_t* - On Success, returns config_value_t object
  • On Failure, returns NULL

Reimplemented from eii::config_manager::AppCfg.

◆ getMsgBusConfig()

config_t* eii::config_manager::PublisherCfg::getMsgBusConfig ( )
overridevirtual

Constructs message bus config for Publisher

Returns
config_t* - On Success, JSON msg bus publisher config of type config_t
  • On failure, On success, returns NULL

Reimplemented from eii::config_manager::AppCfg.

◆ getPubCfg()

cfgmgr_interface_t* eii::config_manager::PublisherCfg::getPubCfg ( )

cfgmgr_interface_t getter to get publisher interface

◆ getTopics()

std::vector<std::string> eii::config_manager::PublisherCfg::getTopics ( )
overridevirtual

To get topics from publisher interface config on which data will be published

Returns
vector<string> - On Success, returns Topics of publisher config
  • On Failure, returns empty vector

Reimplemented from eii::config_manager::AppCfg.

◆ setTopics()

bool eii::config_manager::PublisherCfg::setTopics ( std::vector< std::string >  topics_list)
overridevirtual

To set new topics for publisher in publishers interface config

Parameters
topics_list- List of topics to be set
Returns
bool - Boolean whether topics were set
  • On Success, returns true
  • On Failure, returns false

Reimplemented from eii::config_manager::AppCfg.


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