A singleton class which tracks commonly used configuration options.

#include <CGlobalConfiguration.hpp>

Inheritance diagram for freedm::broker::CGlobalConfiguration:

Public Member Functions
std::string	GetAdapterConfigPath () const
	Get the path to the adapter configuration file. More...

boost::posix_time::time_duration	GetClockSkew () const
	Get the Skew of the local clock. More...

std::string	GetDeviceConfigPath () const
	Get the path to the device class XML specification file. More...

std::string	GetDevicesEndpoint () const
	Get the socket endpoint address. More...

unsigned short	GetFactoryPort () const
	Get the plug-and-play port number. More...

std::string	GetHostname () const
	Get the hostname. More...

bool	GetInvariantCheck () const
	Get the invariant check flag. More...

std::string	GetListenAddress () const
	Get the address. More...

std::string	GetListenPort () const
	Get the port. More...

bool	GetMaliciousFlag () const
	Get the malicious load balance flag. More...

float	GetMigrationStep () const
	Get the size of a load balance migration. More...

std::string	GetMQTTAddress () const
	Get the MQTT broker address. More...

std::string	GetMQTTId () const
	Get the MQTT client identifier. More...

std::vector< std::string >	GetMQTTSubscriptions () const
	Get the MQTT subscriptions. More...

std::string	GetTopologyConfigPath () const
	Path to the topology specification file. More...

std::string	GetUUID () const
	Get the UUID. More...

void	SetAdapterConfigPath (std::string ac)
	Set the path to the adapter configuration file. More...

void	SetClockSkew (boost::posix_time::time_duration t)
	Set the clock skew. More...

void	SetDeviceConfigPath (std::string p)
	Set the path to the device class XML specification file. More...

void	SetDevicesEndpoint (std::string e)
	Set the socket endpoint address. More...

void	SetFactoryPort (unsigned short port)
	Set the plug-and-play port number. More...

void	SetHostname (std::string h)
	Set the hostname. More...

void	SetInvariantCheck (bool flag)
	Set the invariant check flag. More...

void	SetListenAddress (std::string a)
	Set the address to on. More...

void	SetListenPort (std::string p)
	Set the port. More...

void	SetMaliciousFlag (bool flag)
	Set the malicious load balance flag. More...

void	SetMigrationStep (float v)
	Set the size of a load balance migration. More...

void	SetMQTTAddress (std::string address)
	Set the MQTT broker address. More...

void	SetMQTTId (std::string id)
	Set the MQTT client identifier. More...

void	SetMQTTSubscriptions (std::vector< std::string > subs)
	Set the MQTT subscriptions. More...

void	SetTopologyConfigPath (std::string p)
	Set the path to the topology config file. More...

void	SetUUID (std::string u)
	Set the uuid. More...

Static Public Member Functions
static CGlobalConfiguration &	Instance ()
	Returns the singleton instance of the global configuration. More...

Static Public Attributes
static const short	MAX_PACKET_SIZE = SHRT_MAX
	Intentionally signed. UINT16_MAX is too big for a UDP datagram, anyway. More...

Private Attributes
std::string	m_adapterConfigPath
	Socket endpoint address for devices. More...

std::string	m_address
	The node uuid. More...

boost::posix_time::time_duration	m_clockskew
	The listening address. More...

std::string	m_deviceConfigPath
	Path to the adapter configuration. More...

std::string	m_devicesEndpoint
	Port number for adapter factory. More...

unsigned short	m_factory_port
	The skew of the clock. More...

std::string	m_hostname

bool	m_invariant

bool	m_malicious
	Size of a load balance migration. More...

float	m_migrationStep
	Path to the topology config. More...

std::string	m_mqtt_address
	Identifier of the MQTT client. More...

std::string	m_mqtt_id

std::vector< std::string >	m_mqtt_subscriptions
	Address of the MQTT broker. More...

std::string	m_port
	Node hostname. More...

std::string	m_topologyConfigPath
	Path to the device class config. More...

std::string	m_uuid
	Port number. More...

Member Function Documentation

std::string freedm::broker::CGlobalConfiguration::GetAdapterConfigPath ( ) const

inline

boost::posix_time::time_duration freedm::broker::CGlobalConfiguration::GetClockSkew ( ) const

inline

std::string freedm::broker::CGlobalConfiguration::GetDeviceConfigPath ( ) const

inline

std::string freedm::broker::CGlobalConfiguration::GetDevicesEndpoint ( ) const

inline

unsigned short freedm::broker::CGlobalConfiguration::GetFactoryPort ( ) const

inline

std::string freedm::broker::CGlobalConfiguration::GetHostname ( ) const

inline

bool freedm::broker::CGlobalConfiguration::GetInvariantCheck ( ) const

inline

std::string freedm::broker::CGlobalConfiguration::GetListenAddress ( ) const

inline

std::string freedm::broker::CGlobalConfiguration::GetListenPort ( ) const

inline

bool freedm::broker::CGlobalConfiguration::GetMaliciousFlag ( ) const

inline

float freedm::broker::CGlobalConfiguration::GetMigrationStep ( ) const

inline

std::string freedm::broker::CGlobalConfiguration::GetMQTTAddress ( ) const

inline

std::string freedm::broker::CGlobalConfiguration::GetMQTTId ( ) const

inline

std::vector<std::string> freedm::broker::CGlobalConfiguration::GetMQTTSubscriptions ( ) const

inline

std::string freedm::broker::CGlobalConfiguration::GetTopologyConfigPath ( ) const

inline

std::string freedm::broker::CGlobalConfiguration::GetUUID ( ) const

inline

static CGlobalConfiguration& freedm::broker::CGlobalConfiguration::Instance ( )

inlinestatic

void freedm::broker::CGlobalConfiguration::SetAdapterConfigPath ( std::string ac )

inline

void freedm::broker::CGlobalConfiguration::SetClockSkew ( boost::posix_time::time_duration t )

inline

void freedm::broker::CGlobalConfiguration::SetDeviceConfigPath ( std::string p )

inline

void freedm::broker::CGlobalConfiguration::SetDevicesEndpoint ( std::string e )

inline

void freedm::broker::CGlobalConfiguration::SetFactoryPort ( unsigned short port )

inline

void freedm::broker::CGlobalConfiguration::SetHostname ( std::string h )

inline

void freedm::broker::CGlobalConfiguration::SetInvariantCheck ( bool flag )

inline

void freedm::broker::CGlobalConfiguration::SetListenAddress ( std::string a )

inline

void freedm::broker::CGlobalConfiguration::SetListenPort ( std::string p )

inline

void freedm::broker::CGlobalConfiguration::SetMaliciousFlag ( bool flag )

inline

void freedm::broker::CGlobalConfiguration::SetMigrationStep ( float v )

inline

void freedm::broker::CGlobalConfiguration::SetMQTTAddress ( std::string address )

inline

void freedm::broker::CGlobalConfiguration::SetMQTTId ( std::string id )

inline

void freedm::broker::CGlobalConfiguration::SetMQTTSubscriptions ( std::vector< std::string > subs )

inline

void freedm::broker::CGlobalConfiguration::SetTopologyConfigPath ( std::string p )

inline

void freedm::broker::CGlobalConfiguration::SetUUID ( std::string u )

inline

Member Data Documentation

std::string freedm::broker::CGlobalConfiguration::m_adapterConfigPath

private

std::string freedm::broker::CGlobalConfiguration::m_address

private

boost::posix_time::time_duration freedm::broker::CGlobalConfiguration::m_clockskew

private

std::string freedm::broker::CGlobalConfiguration::m_deviceConfigPath

private

std::string freedm::broker::CGlobalConfiguration::m_devicesEndpoint

private

unsigned short freedm::broker::CGlobalConfiguration::m_factory_port

private

std::string freedm::broker::CGlobalConfiguration::m_hostname

private

bool freedm::broker::CGlobalConfiguration::m_invariant

private

bool freedm::broker::CGlobalConfiguration::m_malicious

private

float freedm::broker::CGlobalConfiguration::m_migrationStep

private

std::string freedm::broker::CGlobalConfiguration::m_mqtt_address

private

std::string freedm::broker::CGlobalConfiguration::m_mqtt_id

private

std::vector<std::string> freedm::broker::CGlobalConfiguration::m_mqtt_subscriptions

private

std::string freedm::broker::CGlobalConfiguration::m_port

private

std::string freedm::broker::CGlobalConfiguration::m_topologyConfigPath

private

std::string freedm::broker::CGlobalConfiguration::m_uuid

private

const short freedm::broker::CGlobalConfiguration::MAX_PACKET_SIZE = SHRT_MAX

static

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

/home/docs/checkouts/readthedocs.org/user_builds/freedm/checkouts/latest/Broker/src/CGlobalConfiguration.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Member Function Documentation

Member Data Documentation