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

Public Member Functions

 SubscriberCfg (cfgmgr_interface_t *cfgmgr_interface)
 
config_t * getMsgBusConfig () override
 
config_value_t * getInterfaceValue (const char *key) override
 
std::string getEndpoint () override
 
std::vector< std::string > getTopics () override
 
bool setTopics (std::vector< std::string > topics_list) override
 
cfgmgr_interface_tgetSubCfg ()
 
 ~SubscriberCfg ()
 
- 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 std::vector< std::string > getAllowedClients ()
 
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

◆ SubscriberCfg()

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

SubscriberCfg 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 subscriber

◆ ~SubscriberCfg()

eii::config_manager::SubscriberCfg::~SubscriberCfg ( )

Destructor

Member Function Documentation

◆ getEndpoint()

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

To get endpoint for particular subscriber from its 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::SubscriberCfg::getInterfaceValue ( const char *  key)
overridevirtual

To get particular interface value from Subscriber interface config

Parameters
key- Key on which interface value is extracted.
Returns
config_value_t* - On success, returns config_value_t object On failure, On success, returns NULL

Reimplemented from eii::config_manager::AppCfg.

◆ getMsgBusConfig()

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

Constructs message bus config for Subscriber

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

Reimplemented from eii::config_manager::AppCfg.

◆ getSubCfg()

cfgmgr_interface_t* eii::config_manager::SubscriberCfg::getSubCfg ( )

cfgmgr_interface_t getter to get subscriber interface

◆ getTopics()

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

To gets topics from subscriber interface config on which subscriber receives data

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

Reimplemented from eii::config_manager::AppCfg.

◆ setTopics()

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

To sets new topics for subscriber in subscribers interface config

Parameters
topics_list- List of topics to be set
Returns
bool - Boolean whether topics were set

Reimplemented from eii::config_manager::AppCfg.


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