openjaus::core_v1_1::services::TransportSettings Class Reference

Encapsulates the configuration settings needed by the Transport service. More...

#include <TransportSettings.h>

Inherits openjaus::core_v1_1::services::TransportSettingsInterface.

Public Member Functions
virtual	~TransportSettings ()
virtual bool	isExternalInterfaceEnabled ()
virtual std::vector< system::NetworkInterface >	getExternalInterfaces ()
virtual void	setExternalInterfaces (std::vector< system::NetworkInterface > value)
bool	isTcpEnabled ()
void	setTcpEnabled (bool value)
bool	checkTransportPolicy ()
void	setCheckTransportPolicy (bool value)
virtual bool	useUniqueLoopbackPorts ()
virtual void	setUseUniqueLoopbackPorts (bool value)
virtual uint32	getMaxQueueSize ()
virtual void	setMaxQueueSize (uint32 value)
std::string	getFilterFilename ()
void	setFilterFilename (const std::string &value)
bool	areValid ()
Public Member Functions inherited from openjaus::core_v1_1::services::TransportSettingsInterface
	TransportSettingsInterface ()
virtual	~TransportSettingsInterface ()

Static Public Member Functions
static TransportSettings *	loadFromConfFile (const std::string &componentName)

Private Member Functions
	TransportSettings ()

Static Private Member Functions
static std::vector< system::NetworkInterface >	loadInterfaces ()
static void	throwIfUnsupportedInterfacesListed (const std::vector< std::string > &value)
static void	verifySettingsAndThrowIfError (TransportSettings *settings)

Private Attributes
bool	externalInterfaceEnabled
std::vector< system::NetworkInterface >	externalInterfaces
bool	tcpEnabled
bool	checkTransportPolicyEnabled
bool	uniqueLoopbackPorts
uint32	maxQueueSize
std::string	filterFilename

Detailed Description

Constructor & Destructor Documentation

~TransportSettings()

openjaus::core_v1_1::services::TransportSettings::~TransportSettings ( )

virtual

TransportSettings()

openjaus::core_v1_1::services::TransportSettings::TransportSettings ( )

private

Member Function Documentation

areValid()

bool openjaus::core_v1_1::services::TransportSettings::areValid

(

)

checkTransportPolicy()

bool openjaus::core_v1_1::services::TransportSettings::checkTransportPolicy ( )

virtual

Implements openjaus::core_v1_1::services::TransportSettingsInterface.

getExternalInterfaces()

std::vector< system::NetworkInterface > openjaus::core_v1_1::services::TransportSettings::getExternalInterfaces ( )

virtual

Implements openjaus::core_v1_1::services::TransportSettingsInterface.

getFilterFilename()

std::string openjaus::core_v1_1::services::TransportSettings::getFilterFilename ( )

virtual

Implements openjaus::core_v1_1::services::TransportSettingsInterface.

getMaxQueueSize()

uint32 openjaus::core_v1_1::services::TransportSettings::getMaxQueueSize ( )

virtual

Implements openjaus::core_v1_1::services::TransportSettingsInterface.

isExternalInterfaceEnabled()

bool openjaus::core_v1_1::services::TransportSettings::isExternalInterfaceEnabled ( )

virtual

Implements openjaus::core_v1_1::services::TransportSettingsInterface.

isTcpEnabled()

bool openjaus::core_v1_1::services::TransportSettings::isTcpEnabled ( )

virtual

Implements openjaus::core_v1_1::services::TransportSettingsInterface.

loadFromConfFile()

TransportSettings * openjaus::core_v1_1::services::TransportSettings::loadFromConfFile ( const std::string &  componentName )

static

loadInterfaces()

std::vector< system::NetworkInterface > openjaus::core_v1_1::services::TransportSettings::loadInterfaces ( )

staticprivate

setCheckTransportPolicy()

void openjaus::core_v1_1::services::TransportSettings::setCheckTransportPolicy

(

bool

value

)

setExternalInterfaces()

void openjaus::core_v1_1::services::TransportSettings::setExternalInterfaces ( std::vector< system::NetworkInterface >  value )

virtual

setFilterFilename()

void openjaus::core_v1_1::services::TransportSettings::setFilterFilename

(

const std::string &

value

)

setMaxQueueSize()

void openjaus::core_v1_1::services::TransportSettings::setMaxQueueSize ( uint32  value )

virtual

setTcpEnabled()

void openjaus::core_v1_1::services::TransportSettings::setTcpEnabled

(

bool

value

)

setUseUniqueLoopbackPorts()

void openjaus::core_v1_1::services::TransportSettings::setUseUniqueLoopbackPorts ( bool  value )

virtual

throwIfUnsupportedInterfacesListed()

void openjaus::core_v1_1::services::TransportSettings::throwIfUnsupportedInterfacesListed ( const std::vector< std::string > &  value )

staticprivate

useUniqueLoopbackPorts()

bool openjaus::core_v1_1::services::TransportSettings::useUniqueLoopbackPorts ( )

virtual

Implements openjaus::core_v1_1::services::TransportSettingsInterface.

verifySettingsAndThrowIfError()

void openjaus::core_v1_1::services::TransportSettings::verifySettingsAndThrowIfError ( TransportSettings *  settings )

staticprivate

Member Data Documentation

checkTransportPolicyEnabled

bool openjaus::core_v1_1::services::TransportSettings::checkTransportPolicyEnabled

private

externalInterfaceEnabled

bool openjaus::core_v1_1::services::TransportSettings::externalInterfaceEnabled

private

externalInterfaces

std::vector<system::NetworkInterface> openjaus::core_v1_1::services::TransportSettings::externalInterfaces

private

filterFilename

std::string openjaus::core_v1_1::services::TransportSettings::filterFilename

private

maxQueueSize

uint32 openjaus::core_v1_1::services::TransportSettings::maxQueueSize

private

tcpEnabled

bool openjaus::core_v1_1::services::TransportSettings::tcpEnabled

private

uniqueLoopbackPorts

bool openjaus::core_v1_1::services::TransportSettings::uniqueLoopbackPorts

private

---

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

• include/openjaus/core_v1_1/Services/Settings/TransportSettings.h
• src/openjaus/core_v1_1/Services/Settings/TransportSettings.cpp