DtLatencyReportMsg Class Reference

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

Inheritance diagram for DtLatencyReportMsg:

Collaboration diagram for DtLatencyReportMsg:

List of all members.

Public Member Functions
	DtLatencyReportMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtLatencyReportMsg (const DtAveragedLatencyTestReport &rep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtLatencyReportMsg (const DtNetLatencyReportMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtLatencyReportMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
virtual void	resize (unsigned int payLoadSize)
	Resize the payload size.
virtual unsigned char *	payload ()
	dataPointer to the payload.
virtual const unsigned char *	payload () const
	dataPointer to the payload.
virtual unsigned int	totalSize () const
	What is the total size of the payload?
virtual void	setTotalSize (unsigned int times)
	setTotal Size of the payload.
virtual void	get (DtAveragedLatencyTestReport &report) const
	Decode msg data into input latency test report.
virtual void	set (const DtAveragedLatencyTestReport &report)
	Encode report into message data.
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, DtLatencyReportCb cb, void *usr)
	Adds or removes a callback with the given connection manager for this message type.
static void	removeCallback (DtConnectionMgr *conn, DtLatencyReportCb cb, void *usr)
Protected Member Functions
virtual DtNetLatencyReportMsg *	netLatencyReportMsg ()
	The network representation for the LatencyReportMsg message.
virtual const DtNetLatencyReportMsg *	netLatencyReportMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of a DtLatencyReportMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual unsigned char *	timesPtr () const
	Returns pointer to the times in the netMsg.
virtual void	setTime (DtAssistantReportTimeStampType type, unsigned int time)
	Add a time to the message.

---

Detailed Description

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

---

Constructor & Destructor Documentation

DtLatencyReportMsg::DtLatencyReportMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), netLatencyReportMsg(), and DtNetLatencyReportMsg::totalSize.

Referenced by clone(), and create().

DtLatencyReportMsg::DtLatencyReportMsg	(	const DtAveragedLatencyTestReport &	rep,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

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

DtLatencyReportMsg::DtLatencyReportMsg	(	const DtNetLatencyReportMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

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

DtLatencyReportMsg::~DtLatencyReportMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtLatencyReportMsg::addCallback	(	DtConnectionMgr *	conn,
		DtLatencyReportCb	cb,
		void *	usr
	)		[static]

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

References DtConnectionMgr::addMsgCallback(), and DtLatencyReportMsgKind.

DtRtiMsg * DtLatencyReportMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtLatencyReportMsg(), and netLatencyReportMsg().

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

Creators.

References DtLatencyReportMsg().

DtRtiMsg * DtLatencyReportMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtLatencyReportMsg().

void DtLatencyReportMsg::get

(

DtAveragedLatencyTestReport &

report

)

const [virtual]

Decode msg data into input latency test report.

References DtAveragedLatencyTestReport::decodeFromMsg(), payload(), and totalSize().

Referenced by DtRtiexecObserverForAssistant::processLatencyTestResultsMsg().

DtRtiMsgKind DtLatencyReportMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of a DtLatencyReportMsg message.

Implements DtRtiMsg.

References DtLatencyReportMsgKind.

Referenced by DtLatencyReportMsg().

int DtLatencyReportMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

References totalSize().

DtNetLatencyReportMsg * DtLatencyReportMsg::netLatencyReportMsg

(

)

[protected, virtual]

The network representation for the LatencyReportMsg message.

Referenced by clone(), DtLatencyReportMsg(), setTotalSize(), timesPtr(), and totalSize().

const DtNetLatencyReportMsg * DtLatencyReportMsg::netLatencyReportMsg

(

)

const [protected, virtual]

unsigned char * DtLatencyReportMsg::payload

(

)

[virtual]

dataPointer to the payload.

References timesPtr().

Referenced by get(), printData(), set(), and setTime().

const unsigned char * DtLatencyReportMsg::payload

(

)

const [virtual]

dataPointer to the payload.

References timesPtr().

void DtLatencyReportMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References payload(), and totalSize().

void DtLatencyReportMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtLatencyReportCb	cb,
		void *	usr
	)		[static]

References DtLatencyReportMsgKind, and DtConnectionMgr::removeMsgCallback().

void DtLatencyReportMsg::resize

(

unsigned int

payLoadSize

)

[virtual]

Resize the payload size.

References DtRtiMsg::adjustBytes(), setTotalSize(), timesPtr(), and totalSize().

Referenced by set().

void DtLatencyReportMsg::set

(

const DtAveragedLatencyTestReport &

report

)

[virtual]

Encode report into message data.

References DtAveragedLatencyTestReport::encodeToMsg(), payload(), resize(), and DtAveragedLatencyTestReport::sizeRequiredToDecode().

void DtLatencyReportMsg::setTime	(	DtAssistantReportTimeStampType	type,
		unsigned int	time
	)		[protected, virtual]

Add a time to the message.

References payload(), DtRtiMsg::time(), and totalSize().

void DtLatencyReportMsg::setTotalSize

(

unsigned int

times

)

[virtual]

setTotal Size of the payload.

References netLatencyReportMsg(), and DtNetLatencyReportMsg::totalSize.

Referenced by resize().

unsigned char * DtLatencyReportMsg::timesPtr

(

)

const [protected, virtual]

Returns pointer to the times in the netMsg.

References netLatencyReportMsg(), and DtNetLatencyReportMsg::totalSize.

Referenced by payload(), and resize().

unsigned int DtLatencyReportMsg::totalSize

(

)

const [virtual]

What is the total size of the payload?

References netLatencyReportMsg(), and DtNetLatencyReportMsg::totalSize.

Referenced by get(), minSize(), printData(), resize(), and setTime().

---

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

• latencyReportMsg.h
• latencyReportMsg.cxx