DtForwarderNodeInfoMsg Class Reference

The DtForwarderNodeInfoMsg defines a msg for a client to report the results of a latency test. More...

Inheritance diagram for DtForwarderNodeInfoMsg:

Collaboration diagram for DtForwarderNodeInfoMsg:

List of all members.

Public Member Functions
	DtForwarderNodeInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtForwarderNodeInfoMsg (const DtNetForwarderNodeInfoMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtForwarderNodeInfoMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	printData () const
	Print the data section.
virtual void	setInetAddr (const MAKRti::DtInetAddr &addr)
virtual MAKRti::DtInetAddr	getInetAddr () const
virtual void	setNodeId (unsigned long nodeId)
virtual unsigned long	getNodeId () const
virtual void	setPort (int nodeId)
virtual int	getPort () const
virtual void	setForwarderName (const MAKRti::DtString &name)
virtual MAKRti::DtString	forwarderName () const
virtual void	setForwarderHostName (const MAKRti::DtString &name)
virtual MAKRti::DtString	forwarderHostName () const
virtual void	setKnownForwarderNodes (const std::set< DtForwarderNodeInfo > &nodes)
virtual void	knownForwarderNodes (std::set< DtForwarderNodeInfo > &nodesToPopulate) const
virtual void	setNodeIdForRecipientToUse (unsigned long nodeId)
virtual unsigned long	nodeIdForRecipientToUse () const
Static Public Member Functions
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtConnectionMgr *conn, DtForwarderNodeInfoCb cb, void *usr)
	Adds or removes a callback with the given connection manager for this message type.
static void	removeCallback (DtConnectionMgr *conn, DtForwarderNodeInfoCb cb, void *usr)
Protected Member Functions
virtual DtNetForwarderNodeInfoMsg *	netForwarderNodeInfoMsg ()
	The network representation for the ForwarderNodeInfoMsg message.
virtual const DtNetForwarderNodeInfoMsg *	netForwarderNodeInfoMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of a DtForwarderNodeInfoMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual const char *	forwarderNamePtr () const
	utility functions for getting / setting forwarderName.
virtual char *	forwarderNamePtr ()
virtual void	setForwarderNameSize (unsigned int size)
virtual unsigned int	forwarderNameSize () const
virtual const char *	forwarderHostNamePtr () const
	utility functions for getting / setting forwarderHostName
virtual char *	forwarderHostNamePtr ()
virtual void	setForwarderHostNameSize (unsigned int size)
virtual unsigned int	forwarderHostNameSize () const
virtual void	setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily num)
	utility functions for getting / setting address family of all IP addresses in the message
virtual MAKRti::DtInetUtils::DtInetAddrFamily	addressFamily () const
virtual void	setNumKnownForwarder (unsigned long num)
	utility functions for getting / setting number of known forwarders
virtual unsigned long	numKnownForwarders () const
virtual const DtNetU128 *	knownFwAddrsPtr () const
	utility functions for getting / setting known forwarder addresses
virtual DtNetU128 *	knownFwAddrsPtr ()
virtual const DtNetU32 *	knownFwNodeIdsPtr () const
	utility functions for getting / setting known forwarder node ids
virtual DtNetU32 *	knownFwNodeIdsPtr ()
virtual const char *	knownFwNamesPtr () const
	utility functions for getting / setting known forwarder names
virtual char *	knownFwNamesPtr ()
virtual void	setKnownFwNamesSize (unsigned long size)
virtual unsigned long	knownFwNamesSize () const
virtual const char *	knownFwHostNamesPtr () const
	utility functions for getting / setting known forwarder host names
virtual char *	knownFwHostNamesPtr ()
virtual void	setKnownFwHostNamesSize (unsigned long size)
virtual unsigned long	knownFwHostNamesSize () const

---

Detailed Description

The DtForwarderNodeInfoMsg defines a msg for a client to report the results of a latency test.

---

Constructor & Destructor Documentation

DtForwarderNodeInfoMsg::DtForwarderNodeInfoMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), netForwarderNodeInfoMsg(), and DtNetForwarderNodeInfoMsg::totalSize.

Referenced by clone(), and create().

DtForwarderNodeInfoMsg::DtForwarderNodeInfoMsg	(	const DtNetForwarderNodeInfoMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetForwarderNodeInfoMsg::header, and DtRtiMsg::initDtRtiMsg().

DtForwarderNodeInfoMsg::~DtForwarderNodeInfoMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtForwarderNodeInfoMsg::addCallback	(	DtConnectionMgr *	conn,
		DtForwarderNodeInfoCb	cb,
		void *	usr
	)		[static]

Adds or removes a callback with the given connection manager for this message type.

References DtConnectionMgr::addMsgCallback(), and DtForwarderNodeInfoMsgKind.

MAKRti::DtInetUtils::DtInetAddrFamily DtForwarderNodeInfoMsg::addressFamily

(

)

const [protected, virtual]

References netForwarderNodeInfoMsg().

DtRtiMsg * DtForwarderNodeInfoMsg::clone

(

bool

copy = true

)

const [virtual]

Return a copy/empty object of the same type as this.

Implements DtRtiMsg.

References DtForwarderNodeInfoMsg(), and netForwarderNodeInfoMsg().

DtRtiMsg * DtForwarderNodeInfoMsg::create	(	const DtNetMsgHeader *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)		[static]

Creators.

References DtForwarderNodeInfoMsg().

DtRtiMsg * DtForwarderNodeInfoMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtForwarderNodeInfoMsg().

MAKRti::DtString DtForwarderNodeInfoMsg::forwarderHostName

(

)

const [virtual]

References forwarderHostNamePtr(), and forwarderHostNameSize().

Referenced by printData(), and DtInOutForwarderPort::processForwarderNodeInfoMsg().

const char * DtForwarderNodeInfoMsg::forwarderHostNamePtr

(

)

const [protected, virtual]

utility functions for getting / setting forwarderHostName

References forwarderNamePtr(), and forwarderNameSize().

Referenced by forwarderHostName(), and setForwarderHostName().

char * DtForwarderNodeInfoMsg::forwarderHostNamePtr

(

)

[protected, virtual]

References forwarderNamePtr(), and forwarderNameSize().

unsigned int DtForwarderNodeInfoMsg::forwarderHostNameSize

(

)

const [protected, virtual]

References DtNetForwarderNodeInfoMsg::forwarderHostNameSize, and netForwarderNodeInfoMsg().

Referenced by forwarderHostName(), and setForwarderHostName().

MAKRti::DtString DtForwarderNodeInfoMsg::forwarderName

(

)

const [virtual]

References forwarderNamePtr(), and forwarderNameSize().

Referenced by printData(), and DtInOutForwarderPort::processForwarderNodeInfoMsg().

const char * DtForwarderNodeInfoMsg::forwarderNamePtr

(

)

const [protected, virtual]

utility functions for getting / setting forwarderName.

References knownFwHostNamesPtr(), and knownFwHostNamesSize().

Referenced by forwarderHostNamePtr(), forwarderName(), and setForwarderName().

char * DtForwarderNodeInfoMsg::forwarderNamePtr

(

)

[protected, virtual]

References knownFwHostNamesPtr(), and knownFwHostNamesSize().

unsigned int DtForwarderNodeInfoMsg::forwarderNameSize

(

)

const [protected, virtual]

References DtNetForwarderNodeInfoMsg::forwarderNameSize, and netForwarderNodeInfoMsg().

Referenced by forwarderHostNamePtr(), forwarderName(), and setForwarderName().

MAKRti::DtInetAddr DtForwarderNodeInfoMsg::getInetAddr

(

)

const [virtual]

References netForwarderNodeInfoMsg().

Referenced by printData(), and DtInOutForwarderPort::processForwarderNodeInfoMsg().

unsigned long DtForwarderNodeInfoMsg::getNodeId

(

)

const [virtual]

References DtNetForwarderNodeInfoMsg::forwarderNodeId, and netForwarderNodeInfoMsg().

Referenced by printData(), and DtInOutForwarderPort::processForwarderNodeInfoMsg().

int DtForwarderNodeInfoMsg::getPort

(

)

const [virtual]

References netForwarderNodeInfoMsg(), and DtNetForwarderNodeInfoMsg::port.

Referenced by DtInOutForwarderPort::processForwarderNodeInfoMsg().

DtRtiMsgKind DtForwarderNodeInfoMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of a DtForwarderNodeInfoMsg message.

Implements DtRtiMsg.

References DtForwarderNodeInfoMsgKind.

Referenced by DtForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::knownForwarderNodes

(

std::set< DtForwarderNodeInfo > &

nodesToPopulate

)

const [virtual]

References DtForwarderNodeInfo::myForwarderName, DtForwarderNodeInfo::myHostName, DtForwarderNodeInfo::myIpAddr, and DtForwarderNodeInfo::myNodeId.

Referenced by printData(), and DtInOutForwarderPort::processForwarderNodeInfoMsg().

const DtNetU128 * DtForwarderNodeInfoMsg::knownFwAddrsPtr

(

)

const [protected, virtual]

utility functions for getting / setting known forwarder addresses

References netForwarderNodeInfoMsg().

Referenced by knownFwNodeIdsPtr(), and setKnownForwarderNodes().

DtNetU128 * DtForwarderNodeInfoMsg::knownFwAddrsPtr

(

)

[protected, virtual]

References netForwarderNodeInfoMsg().

const char * DtForwarderNodeInfoMsg::knownFwHostNamesPtr

(

)

const [protected, virtual]

utility functions for getting / setting known forwarder host names

References knownFwNamesPtr(), and knownFwNamesSize().

Referenced by forwarderNamePtr(), and setKnownForwarderNodes().

char * DtForwarderNodeInfoMsg::knownFwHostNamesPtr

(

)

[protected, virtual]

References knownFwNamesPtr(), and knownFwNamesSize().

unsigned long DtForwarderNodeInfoMsg::knownFwHostNamesSize

(

)

const [protected, virtual]

References DtNetForwarderNodeInfoMsg::knownForwarderHostNamesSize, and netForwarderNodeInfoMsg().

Referenced by forwarderNamePtr(), and setKnownForwarderNodes().

const char * DtForwarderNodeInfoMsg::knownFwNamesPtr

(

)

const [protected, virtual]

utility functions for getting / setting known forwarder names

References knownFwNodeIdsPtr(), and numKnownForwarders().

Referenced by knownFwHostNamesPtr(), and setKnownForwarderNodes().

char * DtForwarderNodeInfoMsg::knownFwNamesPtr

(

)

[protected, virtual]

References knownFwNodeIdsPtr(), and numKnownForwarders().

unsigned long DtForwarderNodeInfoMsg::knownFwNamesSize

(

)

const [protected, virtual]

References DtNetForwarderNodeInfoMsg::knownForwarderNamesSize, and netForwarderNodeInfoMsg().

Referenced by knownFwHostNamesPtr(), and setKnownForwarderNodes().

const DtNetU32 * DtForwarderNodeInfoMsg::knownFwNodeIdsPtr

(

)

const [protected, virtual]

utility functions for getting / setting known forwarder node ids

References knownFwAddrsPtr(), and numKnownForwarders().

Referenced by knownFwNamesPtr(), and setKnownForwarderNodes().

DtNetU32 * DtForwarderNodeInfoMsg::knownFwNodeIdsPtr

(

)

[protected, virtual]

References knownFwAddrsPtr(), and numKnownForwarders().

int DtForwarderNodeInfoMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

DtNetForwarderNodeInfoMsg * DtForwarderNodeInfoMsg::netForwarderNodeInfoMsg

(

)

[protected, virtual]

The network representation for the ForwarderNodeInfoMsg message.

Referenced by addressFamily(), clone(), DtForwarderNodeInfoMsg(), forwarderHostNameSize(), forwarderNameSize(), getInetAddr(), getNodeId(), getPort(), knownFwAddrsPtr(), knownFwHostNamesSize(), knownFwNamesSize(), nodeIdForRecipientToUse(), numKnownForwarders(), setAddressFamily(), setForwarderHostNameSize(), setForwarderNameSize(), setInetAddr(), setKnownForwarderNodes(), setKnownFwHostNamesSize(), setKnownFwNamesSize(), setNodeId(), setNodeIdForRecipientToUse(), setNumKnownForwarder(), and setPort().

const DtNetForwarderNodeInfoMsg * DtForwarderNodeInfoMsg::netForwarderNodeInfoMsg

(

)

const [protected, virtual]

unsigned long DtForwarderNodeInfoMsg::nodeIdForRecipientToUse

(

)

const [virtual]

References netForwarderNodeInfoMsg(), and DtNetForwarderNodeInfoMsg::recipientNodeId.

Referenced by printData(), and DtInOutForwarderPort::processForwarderNodeInfoMsg().

unsigned long DtForwarderNodeInfoMsg::numKnownForwarders

(

)

const [protected, virtual]

References netForwarderNodeInfoMsg(), and DtNetForwarderNodeInfoMsg::numKnownForwarders.

Referenced by knownFwNamesPtr(), knownFwNodeIdsPtr(), and setKnownForwarderNodes().

void DtForwarderNodeInfoMsg::printData

(

)

const [virtual]

Print the data section.

References forwarderHostName(), forwarderName(), getInetAddr(), getNodeId(), knownForwarderNodes(), and nodeIdForRecipientToUse().

void DtForwarderNodeInfoMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtForwarderNodeInfoCb	cb,
		void *	usr
	)		[static]

References DtForwarderNodeInfoMsgKind, and DtConnectionMgr::removeMsgCallback().

void DtForwarderNodeInfoMsg::setAddressFamily

(

MAKRti::DtInetUtils::DtInetAddrFamily

num

)

[protected, virtual]

utility functions for getting / setting address family of all IP addresses in the message

References DtNetForwarderNodeInfoMsg::addrFamily, and netForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setForwarderHostName

(

const MAKRti::DtString &

name

)

[virtual]

References forwarderHostNamePtr(), forwarderHostNameSize(), rti1516e::insertBytes(), and setForwarderHostNameSize().

Referenced by DtInOutForwarderPort::sendForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setForwarderHostNameSize

(

unsigned int

size

)

[protected, virtual]

References DtNetForwarderNodeInfoMsg::forwarderHostNameSize, and netForwarderNodeInfoMsg().

Referenced by setForwarderHostName().

void DtForwarderNodeInfoMsg::setForwarderName

(

const MAKRti::DtString &

name

)

[virtual]

References forwarderNamePtr(), forwarderNameSize(), rti1516e::insertBytes(), and setForwarderNameSize().

Referenced by DtInOutForwarderPort::sendForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setForwarderNameSize

(

unsigned int

size

)

[protected, virtual]

References DtNetForwarderNodeInfoMsg::forwarderNameSize, and netForwarderNodeInfoMsg().

Referenced by setForwarderName().

void DtForwarderNodeInfoMsg::setInetAddr

(

const MAKRti::DtInetAddr &

addr

)

[virtual]

References DtNetForwarderNodeInfoMsg::addrFamily, DtNetForwarderNodeInfoMsg::forwarderIpAddr, and netForwarderNodeInfoMsg().

Referenced by DtInOutForwarderPort::sendForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setKnownForwarderNodes

(

const std::set< DtForwarderNodeInfo > &

nodes

)

[virtual]

References rti1516e::insertBytes(), knownFwAddrsPtr(), knownFwHostNamesPtr(), knownFwHostNamesSize(), knownFwNamesPtr(), knownFwNamesSize(), knownFwNodeIdsPtr(), DtForwarderNodeInfo::myForwarderName, DtForwarderNodeInfo::myHostName, DtForwarderNodeInfo::myIpAddr, DtForwarderNodeInfo::myNodeId, netForwarderNodeInfoMsg(), DtNetForwarderNodeInfoMsg::numKnownForwarders, numKnownForwarders(), and setNumKnownForwarder().

Referenced by DtInOutForwarderPort::sendForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setKnownFwHostNamesSize

(

unsigned long

size

)

[protected, virtual]

References DtNetForwarderNodeInfoMsg::knownForwarderHostNamesSize, and netForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setKnownFwNamesSize

(

unsigned long

size

)

[protected, virtual]

References DtNetForwarderNodeInfoMsg::knownForwarderNamesSize, and netForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setNodeId

(

unsigned long

nodeId

)

[virtual]

References DtNetForwarderNodeInfoMsg::forwarderNodeId, and netForwarderNodeInfoMsg().

Referenced by DtInOutForwarderPort::sendForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setNodeIdForRecipientToUse

(

unsigned long

nodeId

)

[virtual]

References netForwarderNodeInfoMsg(), and DtNetForwarderNodeInfoMsg::recipientNodeId.

Referenced by DtInOutForwarderPort::sendForwarderNodeInfoMsg().

void DtForwarderNodeInfoMsg::setNumKnownForwarder

(

unsigned long

num

)

[protected, virtual]

utility functions for getting / setting number of known forwarders

References netForwarderNodeInfoMsg(), and DtNetForwarderNodeInfoMsg::numKnownForwarders.

Referenced by setKnownForwarderNodes().

void DtForwarderNodeInfoMsg::setPort

(

int

nodeId

)

[virtual]

References netForwarderNodeInfoMsg(), and DtNetForwarderNodeInfoMsg::port.

Referenced by DtInOutForwarderPort::sendForwarderNodeInfoMsg().

---

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

• forwarderNodeInfoMsg.h
• forwarderNodeInfoMsg.cxx