Class encapsulating network description for multi-machine processings. More...

#include <NetworkDescription.h>

Inheritance diagram for ipsdk::core::NetworkDescription:

Public Member Functions
bool	isInit () const
	retrieve object initialization flag

void	init (ipUInt32 portNumber, const tcpip::eIPAddressType &iPAddressType)
	initialization of object

ipUInt32	getPortNumber () const

const tcpip::eIPAddressType &	getIPAddressType () const

bool	isValidAddress (const tcpip::Address &address) const
	check whether a given address is valid regards to address type associated to object More...

bool	existsAddress (const tcpip::Address &address) const
	check whether a given address exists into collection More...

bool	isMasterAddress (const tcpip::Address &address) const
	check whether a given address is a master address More...

bool	isSlaveAddress (const tcpip::Address &address) const
	check whether a given address is a slave address More...

void	addMasterAddress (const tcpip::Address &masterAddress)
	add a master address to collection More...

void	addSlaveAddress (const tcpip::Address &masterAddress, const AddressColl &slavesColl)
	add a collection of slave addresses to collection More...

void	addSlaveAddress (const tcpip::Address &masterAddress, const tcpip::Address &slaveAddress)
	add a slave address to collection More...

const AddressHierarchy &	getAddressHierarchy () const
	retrieve collection of master ip addresses associated to ip addresses of their slave More...

const AddressColl &	getSlavesColl (const tcpip::Address &masterAddress) const
	retrieve slaves collection associated to a given master address More...

const tcpip::Address &	getMasterAddress (const tcpip::Address &slaveAddress) const
	retrieve master associated to a given slave address More...

const AddressColl &	getGlobalAddressColl () const
	retrieve collection of all ip addresses associated to object More...

void	clear ()
	remove data from object

Constructors and destructors
	NetworkDescription ()

	~NetworkDescription ()

Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.

virtual	~BaseSerializationObject ()=0
	destructor

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name

virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type

virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type

virtual bool	hasCopySupport () const =0
	check whether objet has copy support

virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...

virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...

	BaseDynamicObject ()

virtual	~BaseDynamicObject ()=0

Protected Attributes
ipUInt32	_portNumber
	port number used for connections

tcpip::eIPAddressType	_ipAddressType
	type of ip addresses used

AddressHierarchy	_addressHierarchy

AddressColl	_globalAddressColl
	collection of all ip addresses associated to object

bool	_bInit
	object initialization flag

Additional Inherited Members
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object

virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Detailed Description

Class encapsulating network description for multi-machine processings.

Author: E. Noirfalise

Date: 2013/11/28

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getPortNumber()

ipUInt32 ipsdk::core::NetworkDescription::getPortNumber ( ) const

retrieve port number associated to object

Exceptions

ipsdk::core::IPSDKCoreException if isInit() == false

◆ getIPAddressType()

const tcpip::eIPAddressType& ipsdk::core::NetworkDescription::getIPAddressType ( ) const

retrieve ip address type associated to object

Exceptions

ipsdk::core::IPSDKCoreException if isInit() == false

◆ isValidAddress()

bool ipsdk::core::NetworkDescription::isValidAddress ( const tcpip::Address & address ) const

check whether a given address is valid regards to address type associated to object

Exceptions

ipsdk::core::IPSDKCoreException if isInit() == false

◆ existsAddress()

bool ipsdk::core::NetworkDescription::existsAddress ( const tcpip::Address & address ) const

check whether a given address exists into collection

Exceptions

ipsdk::core::IPSDKCoreException if isInit() == false

◆ isMasterAddress()

bool ipsdk::core::NetworkDescription::isMasterAddress ( const tcpip::Address & address ) const

check whether a given address is a master address

Exceptions

ipsdk::core::IPSDKCoreException if existsAddress(address) == false

◆ isSlaveAddress()

bool ipsdk::core::NetworkDescription::isSlaveAddress ( const tcpip::Address & address ) const

check whether a given address is a slave address

Exceptions

ipsdk::core::IPSDKCoreException if existsAddress(address) == false

◆ addMasterAddress()

void ipsdk::core::NetworkDescription::addMasterAddress ( const tcpip::Address & masterAddress )

add a master address to collection

Exceptions

ipsdk::core::IPSDKCoreException	if isValidAddress(masterAddress) == false
ipsdk::core::IPSDKCoreException	if existsAddress(masterAddress) == true

◆ addSlaveAddress() [1/2]

void ipsdk::core::NetworkDescription::addSlaveAddress	(	const tcpip::Address &	masterAddress,
		const AddressColl &	slavesColl
	)

add a collection of slave addresses to collection

Exceptions

ipsdk::core::IPSDKCoreException	if isMasterAddress(masterAddress) == false
ipsdk::core::IPSDKCoreException	if isValidAddress(slavesColl[i]) == false
ipsdk::core::IPSDKCoreException	if existsAddress(slavesColl[i]) == true

◆ addSlaveAddress() [2/2]

void ipsdk::core::NetworkDescription::addSlaveAddress	(	const tcpip::Address &	masterAddress,
		const tcpip::Address &	slaveAddress
	)

add a slave address to collection

Exceptions

ipsdk::core::IPSDKCoreException	if isMasterAddress(masterAddress) == false
ipsdk::core::IPSDKCoreException	if isValidAddress(slaveAddress) == false
ipsdk::core::IPSDKCoreException	if existsAddress(slaveAddress) == false

◆ getAddressHierarchy()

const AddressHierarchy& ipsdk::core::NetworkDescription::getAddressHierarchy ( ) const

retrieve collection of master ip addresses associated to ip addresses of their slave

Exceptions

ipsdk::core::IPSDKCoreException if isInit() == false

◆ getSlavesColl()

const AddressColl& ipsdk::core::NetworkDescription::getSlavesColl ( const tcpip::Address & masterAddress ) const

retrieve slaves collection associated to a given master address

Exceptions

ipsdk::core::IPSDKCoreException if isMasterAddress(masterAddress) == false

◆ getMasterAddress()

const tcpip::Address& ipsdk::core::NetworkDescription::getMasterAddress ( const tcpip::Address & slaveAddress ) const

retrieve master associated to a given slave address

Exceptions

ipsdk::core::IPSDKCoreException if isSlaveAddress(slaveAddress) == false

◆ getGlobalAddressColl()

const AddressColl& ipsdk::core::NetworkDescription::getGlobalAddressColl ( ) const

retrieve collection of all ip addresses associated to object

Exceptions

ipsdk::core::IPSDKCoreException if isInit() == false

Member Data Documentation

◆ _addressHierarchy

AddressHierarchy ipsdk::core::NetworkDescription::_addressHierarchy

protected

collection of master ip addresses associated to ip addresses of their slave

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKCore/Config/Network/NetworkDescription.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getPortNumber()

◆ getIPAddressType()

◆ isValidAddress()

◆ existsAddress()

◆ isMasterAddress()

◆ isSlaveAddress()

◆ addMasterAddress()

◆ addSlaveAddress() [1/2]

◆ addSlaveAddress() [2/2]

◆ getAddressHierarchy()

◆ getSlavesColl()

◆ getMasterAddress()

◆ getGlobalAddressColl()

Member Data Documentation

◆ _addressHierarchy