DtForwarderPortMsg Class Reference

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

Inheritance diagram for DtForwarderPortMsg:

Collaboration diagram for DtForwarderPortMsg:

List of all members.

Public Member Functions
	DtForwarderPortMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtForwarderPortMsg (const DtNetForwarderPortMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtForwarderPortMsg ()
	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	setListeningPort (unsigned port)
	Accessor and mutator for the listening port the sender.
virtual unsigned	listeningPort () const
virtual void	setConnectedPort (unsigned port)
	Accessor and mutator for the port used for this socket connection.
virtual unsigned	connectedPort () const
virtual void	setAddress (const MAKRti::DtInetAddr &addressValue)
	Accessor and mutator for the address of the remote forwarder.
virtual MAKRti::DtInetAddr	address () 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, DtForwarderPortCb cb, void *usr)
	Adds or removes a callback with the given connection manager for this message type.
static void	removeCallback (DtConnectionMgr *conn, DtForwarderPortCb cb, void *usr)
Protected Member Functions
virtual DtNetForwarderPortMsg *	netForwarderPortMsg ()
	The network representation for the DtForwarderPortMsg message.
virtual const DtNetForwarderPortMsg *	netForwarderPortMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of a DtForwarderPortMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.

---

Detailed Description

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

---

Constructor & Destructor Documentation

DtForwarderPortMsg::DtForwarderPortMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

References DtRtiMsg::initDtRtiMsg(), and internalDtRtiMsgKind().

Referenced by clone(), and create().

DtForwarderPortMsg::DtForwarderPortMsg	(	const DtNetForwarderPortMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

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

DtForwarderPortMsg::~DtForwarderPortMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtForwarderPortMsg::addCallback	(	DtConnectionMgr *	conn,
		DtForwarderPortCb	cb,
		void *	usr
	)		[static]

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

References DtConnectionMgr::addMsgCallback(), and DtForwarderPortMsgKind.

MAKRti::DtInetAddr DtForwarderPortMsg::address

(

)

const [virtual]

References netForwarderPortMsg().

Referenced by DtInOutForwarderPort::processPortMsg().

DtRtiMsg * DtForwarderPortMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtForwarderPortMsg(), and netForwarderPortMsg().

unsigned DtForwarderPortMsg::connectedPort

(

)

const [virtual]

References DtNetForwarderPortMsg::connectedPort, and netForwarderPortMsg().

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

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

Creators.

References DtForwarderPortMsg().

DtRtiMsg * DtForwarderPortMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtForwarderPortMsg().

DtRtiMsgKind DtForwarderPortMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of a DtForwarderPortMsg message.

Implements DtRtiMsg.

References DtForwarderPortMsgKind.

Referenced by DtForwarderPortMsg().

unsigned DtForwarderPortMsg::listeningPort

(

)

const [virtual]

References DtNetForwarderPortMsg::listeningPort, and netForwarderPortMsg().

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

int DtForwarderPortMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

DtNetForwarderPortMsg * DtForwarderPortMsg::netForwarderPortMsg

(

)

[protected, virtual]

The network representation for the DtForwarderPortMsg message.

Referenced by address(), clone(), connectedPort(), listeningPort(), setAddress(), setConnectedPort(), and setListeningPort().

const DtNetForwarderPortMsg * DtForwarderPortMsg::netForwarderPortMsg

(

)

const [protected, virtual]

void DtForwarderPortMsg::printData

(

)

const [virtual]

Print the data section.

References connectedPort(), and listeningPort().

void DtForwarderPortMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtForwarderPortCb	cb,
		void *	usr
	)		[static]

References DtForwarderPortMsgKind, and DtConnectionMgr::removeMsgCallback().

void DtForwarderPortMsg::setAddress

(

const MAKRti::DtInetAddr &

addressValue

)

[virtual]

Accessor and mutator for the address of the remote forwarder.

May not match the address we know it by, depending on router configuration.

References DtNetForwarderPortMsg::addrFamily, DtNetForwarderPortMsg::ipAddr, and netForwarderPortMsg().

Referenced by DtInOutForwarderPort::sendPortMsg().

void DtForwarderPortMsg::setConnectedPort

(

unsigned

port

)

[virtual]

Accessor and mutator for the port used for this socket connection.

References DtNetForwarderPortMsg::connectedPort, and netForwarderPortMsg().

Referenced by DtInOutForwarderPort::sendPortMsg().

void DtForwarderPortMsg::setListeningPort

(

unsigned

port

)

[virtual]

Accessor and mutator for the listening port the sender.

References DtNetForwarderPortMsg::listeningPort, and netForwarderPortMsg().

Referenced by DtInOutForwarderPort::sendPortMsg().

---

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

• forwarderPortMsg.h
• forwarderPortMsg.cxx