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

Inheritance diagram for DtAssistantLatencyReportMsg:

Collaboration diagram for DtAssistantLatencyReportMsg:

Public Member Functions
	DtAssistantLatencyReportMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantLatencyReportMsg (const DtAveragedLatencyTestReport &rep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtAssistantLatencyReportMsg (const DtNetAssistantLatencyReportMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantLatencyReportMsg ()
	Destructor.
virtual DtAssistantMsg *	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	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 DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantServer conn, DtAssistantLatencyReportCb cb, void usr)
	Adds or removes a callback with the given Assistant client for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantLatencyReportCb cb, void usr)
static void	addCallback (DtRtiAssistantPeer conn, DtAssistantLatencyReportCb cb, void usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer conn, DtAssistantLatencyReportCb cb, void usr)
Protected Member Functions
virtual DtNetAssistantLatencyReportMsg *	netAssistantLatencyReportMsg ()
	The network representation for the AssistantLatencyReportMsg message.
virtual const DtNetAssistantLatencyReportMsg *	netAssistantLatencyReportMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantLatencyReportMsg 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 DtAssistantLatencyReportMsg defines a msg for a client to report the results of a latency test.

Constructor & Destructor Documentation

DtAssistantLatencyReportMsg::DtAssistantLatencyReportMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), netAssistantLatencyReportMsg(), and DtNetAssistantLatencyReportMsg::totalSize.

Referenced by clone(), and create().

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

References DtAssistantMsg::initAssistantMsg(), and internalMsgKind().

DtAssistantLatencyReportMsg::DtAssistantLatencyReportMsg	(	const DtNetAssistantLatencyReportMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtNetAssistantLatencyReportMsg::header, and DtAssistantMsg::initAssistantMsg().

DtAssistantLatencyReportMsg::~DtAssistantLatencyReportMsg ( ) [virtual]

Destructor.

Member Function Documentation

void DtAssistantLatencyReportMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantLatencyReportCb	cb,
		void *	usr
	)		`[static]`

Adds or removes a callback with the given Assistant client for this message type.

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantLatencyReportMsgKind.

Referenced by DtAssistantLatencyTestMgr::DtAssistantLatencyTestMgr().

void DtAssistantLatencyReportMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantLatencyReportCb	cb,
		void *	usr
	)		`[static]`

Adds or removes a callback with the given Assistant peer for this message type.

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantLatencyReportMsgKind.

DtAssistantMsg * DtAssistantLatencyReportMsg::clone ( bool copy = true ) const [virtual]

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

Implements DtAssistantMsg.

References DtAssistantLatencyReportMsg(), and netAssistantLatencyReportMsg().

DtAssistantMsg * DtAssistantLatencyReportMsg::create	(	const DtNetAssistantMsgHeader *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)		`[static]`

Creators.

References DtAssistantLatencyReportMsg().

DtAssistantMsg * DtAssistantLatencyReportMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER ) [static]

References DtAssistantLatencyReportMsg().

void DtAssistantLatencyReportMsg::get ( DtAveragedLatencyTestReport & report ) const [virtual]

Decode msg data into input latency test report.

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

Referenced by DtAssistantLatencyTestMgr::processLatencyTestResults().

DtAssistantMsgKind DtAssistantLatencyReportMsg::internalMsgKind ( ) [protected, virtual]

Returns the kind of a DtAssistantLatencyReportMsg message.

Implements DtAssistantMsg.

References DtAssistantLatencyReportMsgKind.

Referenced by DtAssistantLatencyReportMsg().

int DtAssistantLatencyReportMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

References totalSize().

DtNetAssistantLatencyReportMsg * DtAssistantLatencyReportMsg::netAssistantLatencyReportMsg ( ) [protected, virtual]

The network representation for the AssistantLatencyReportMsg message.

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

const DtNetAssistantLatencyReportMsg * DtAssistantLatencyReportMsg::netAssistantLatencyReportMsg ( ) const [protected, virtual]

unsigned char * DtAssistantLatencyReportMsg::payload ( ) [virtual]

dataPointer to the payload.

References timesPtr().

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

const unsigned char * DtAssistantLatencyReportMsg::payload ( ) const [virtual]

dataPointer to the payload.

References timesPtr().

void DtAssistantLatencyReportMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

void DtAssistantLatencyReportMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantLatencyReportCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantLatencyReportMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantLatencyTestMgr::~DtAssistantLatencyTestMgr().

void DtAssistantLatencyReportMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantLatencyReportCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantLatencyReportMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

void DtAssistantLatencyReportMsg::resize ( unsigned int payLoadSize ) [virtual]

Resize the payload size.

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

Referenced by set().

void DtAssistantLatencyReportMsg::set ( const DtAveragedLatencyTestReport & report ) [virtual]

Encode report into message data.

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

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

Add a time to the message.

References payload(), and totalSize().

void DtAssistantLatencyReportMsg::setTotalSize ( unsigned int times ) [virtual]

setTotal Size of the payload.

References netAssistantLatencyReportMsg(), and DtNetAssistantLatencyReportMsg::totalSize.

Referenced by resize().

unsigned char * DtAssistantLatencyReportMsg::timesPtr ( ) const [protected, virtual]

Returns pointer to the times in the netMsg.

References netAssistantLatencyReportMsg(), and DtNetAssistantLatencyReportMsg::totalSize.

Referenced by payload(), and resize().

unsigned int DtAssistantLatencyReportMsg::totalSize ( ) const [virtual]

What is the total size of the payload?

References netAssistantLatencyReportMsg(), and DtNetAssistantLatencyReportMsg::totalSize.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation